]> git.openstreetmap.org Git - nominatim.git/blob - lib-sql/functions/utils.sql
Merge pull request #2450 from mtmail/tiger-data-2021
[nominatim.git] / lib-sql / functions / utils.sql
1 -- Assorted helper functions for the triggers.
2
3 CREATE OR REPLACE FUNCTION geometry_sector(partition INTEGER, place geometry)
4   RETURNS INTEGER
5   AS $$
6 DECLARE
7   NEWgeometry geometry;
8 BEGIN
9 --  RAISE WARNING '%',place;
10   NEWgeometry := ST_PointOnSurface(place);
11   RETURN (partition*1000000) + (500-ST_X(NEWgeometry)::integer)*1000 + (500-ST_Y(NEWgeometry)::integer);
12 END;
13 $$
14 LANGUAGE plpgsql IMMUTABLE;
15
16
17 CREATE OR REPLACE FUNCTION array_merge(a INTEGER[], b INTEGER[])
18   RETURNS INTEGER[]
19   AS $$
20 DECLARE
21   i INTEGER;
22   r INTEGER[];
23 BEGIN
24   IF array_upper(a, 1) IS NULL THEN
25     RETURN b;
26   END IF;
27   IF array_upper(b, 1) IS NULL THEN
28     RETURN a;
29   END IF;
30   r := a;
31   FOR i IN 1..array_upper(b, 1) LOOP  
32     IF NOT (ARRAY[b[i]] <@ r) THEN
33       r := r || b[i];
34     END IF;
35   END LOOP;
36   RETURN r;
37 END;
38 $$
39 LANGUAGE plpgsql IMMUTABLE;
40
41 -- Return the node members with a given label from a relation member list
42 -- as a set.
43 --
44 -- \param members      Member list in osm2pgsql middle format.
45 -- \param memberLabels Array of labels to accept.
46 --
47 -- \returns Set of OSM ids of nodes that are found.
48 --
49 CREATE OR REPLACE FUNCTION get_rel_node_members(members TEXT[],
50                                                 memberLabels TEXT[])
51   RETURNS SETOF BIGINT
52   AS $$
53 DECLARE
54   i INTEGER;
55 BEGIN
56   FOR i IN 1..ARRAY_UPPER(members,1) BY 2 LOOP
57     IF members[i+1] = ANY(memberLabels)
58        AND upper(substring(members[i], 1, 1))::char(1) = 'N'
59     THEN
60       RETURN NEXT substring(members[i], 2)::bigint;
61     END IF;
62   END LOOP;
63
64   RETURN;
65 END;
66 $$
67 LANGUAGE plpgsql IMMUTABLE;
68
69 -- Copy 'name' to or from the default language.
70 --
71 -- \param country_code     Country code of the object being named.
72 -- \param[inout] name      List of names of the object.
73 --
74 -- If the country named by country_code has a single default language,
75 -- then a `name` tag is copied to `name:<country_code>` if this tag does
76 -- not yet exist and vice versa.
77 CREATE OR REPLACE FUNCTION add_default_place_name(country_code VARCHAR(2),
78                                                   INOUT name HSTORE)
79   AS $$
80 DECLARE
81   default_language VARCHAR(10);
82 BEGIN
83   IF name is not null AND array_upper(akeys(name),1) > 1 THEN
84     default_language := get_country_language_code(country_code);
85     IF default_language IS NOT NULL THEN
86       IF name ? 'name' AND NOT name ? ('name:'||default_language) THEN
87         name := name || hstore(('name:'||default_language), (name -> 'name'));
88       ELSEIF name ? ('name:'||default_language) AND NOT name ? 'name' THEN
89         name := name || hstore('name', (name -> ('name:'||default_language)));
90       END IF;
91     END IF;
92   END IF;
93 END;
94 $$
95 LANGUAGE plpgsql IMMUTABLE;
96
97
98 -- Find the nearest artificial postcode for the given geometry.
99 -- TODO For areas there should not be more than two inside the geometry.
100 CREATE OR REPLACE FUNCTION get_nearest_postcode(country VARCHAR(2), geom GEOMETRY)
101   RETURNS TEXT
102   AS $$
103 DECLARE
104   outcode TEXT;
105   cnt INTEGER;
106 BEGIN
107     -- If the geometry is an area then only one postcode must be within
108     -- that area, otherwise consider the area as not having a postcode.
109     IF ST_GeometryType(geom) in ('ST_Polygon','ST_MultiPolygon') THEN
110         SELECT min(postcode), count(*) FROM
111               (SELECT postcode FROM location_postcode
112                 WHERE ST_Contains(geom, location_postcode.geometry) LIMIT 2) sub
113           INTO outcode, cnt;
114
115         IF cnt = 1 THEN
116             RETURN outcode;
117         ELSE
118             RETURN null;
119         END IF;
120     END IF;
121
122     SELECT postcode FROM location_postcode
123      WHERE ST_DWithin(geom, location_postcode.geometry, 0.05)
124           AND location_postcode.country_code = country
125      ORDER BY ST_Distance(geom, location_postcode.geometry) LIMIT 1
126     INTO outcode;
127
128     RETURN outcode;
129 END;
130 $$
131 LANGUAGE plpgsql STABLE;
132
133
134 CREATE OR REPLACE FUNCTION get_country_code(place geometry)
135   RETURNS TEXT
136   AS $$
137 DECLARE
138   place_centre GEOMETRY;
139   nearcountry RECORD;
140 BEGIN
141   place_centre := ST_PointOnSurface(place);
142
143 -- RAISE WARNING 'get_country_code, start: %', ST_AsText(place_centre);
144
145   -- Try for a OSM polygon
146   FOR nearcountry IN
147     SELECT country_code from location_area_country
148     WHERE country_code is not null and st_covers(geometry, place_centre) limit 1
149   LOOP
150     RETURN nearcountry.country_code;
151   END LOOP;
152
153 -- RAISE WARNING 'osm fallback: %', ST_AsText(place_centre);
154
155   -- Try for OSM fallback data
156   -- The order is to deal with places like HongKong that are 'states' within another polygon
157   FOR nearcountry IN
158     SELECT country_code from country_osm_grid
159     WHERE st_covers(geometry, place_centre) order by area asc limit 1
160   LOOP
161     RETURN nearcountry.country_code;
162   END LOOP;
163
164 -- RAISE WARNING 'near osm fallback: %', ST_AsText(place_centre);
165
166   -- 
167   FOR nearcountry IN
168     SELECT country_code from country_osm_grid
169     WHERE st_dwithin(geometry, place_centre, 0.5)
170     ORDER BY st_distance(geometry, place_centre) asc, area asc limit 1
171   LOOP
172     RETURN nearcountry.country_code;
173   END LOOP;
174
175   RETURN NULL;
176 END;
177 $$
178 LANGUAGE plpgsql STABLE;
179
180
181 CREATE OR REPLACE FUNCTION get_country_language_code(search_country_code VARCHAR(2))
182   RETURNS TEXT
183   AS $$
184 DECLARE
185   nearcountry RECORD;
186 BEGIN
187   FOR nearcountry IN
188     SELECT distinct country_default_language_code from country_name
189     WHERE country_code = search_country_code limit 1
190   LOOP
191     RETURN lower(nearcountry.country_default_language_code);
192   END LOOP;
193   RETURN NULL;
194 END;
195 $$
196 LANGUAGE plpgsql STABLE;
197
198
199 CREATE OR REPLACE FUNCTION get_partition(in_country_code VARCHAR(10))
200   RETURNS INTEGER
201   AS $$
202 DECLARE
203   nearcountry RECORD;
204 BEGIN
205   FOR nearcountry IN
206     SELECT partition from country_name where country_code = in_country_code
207   LOOP
208     RETURN nearcountry.partition;
209   END LOOP;
210   RETURN 0;
211 END;
212 $$
213 LANGUAGE plpgsql STABLE;
214
215
216 -- Find the parent of an address with addr:street/addr:place tag.
217 --
218 -- \param token_info Naming info with the address information.
219 -- \param partition  Partition where to search the parent.
220 -- \param centroid   Location of the address.
221 --
222 -- \return Place ID of the parent if one was found, NULL otherwise.
223 CREATE OR REPLACE FUNCTION find_parent_for_address(token_info JSONB,
224                                                    partition SMALLINT,
225                                                    centroid GEOMETRY)
226   RETURNS BIGINT
227   AS $$
228 DECLARE
229   parent_place_id BIGINT;
230 BEGIN
231   -- Check for addr:street attributes
232   parent_place_id := getNearestNamedRoadPlaceId(partition, centroid, token_info);
233   IF parent_place_id is not null THEN
234     {% if debug %}RAISE WARNING 'Get parent from addr:street: %', parent_place_id;{% endif %}
235     RETURN parent_place_id;
236   END IF;
237
238   -- Check for addr:place attributes.
239   parent_place_id := getNearestNamedPlacePlaceId(partition, centroid, token_info);
240   {% if debug %}RAISE WARNING 'Get parent from addr:place: %', parent_place_id;{% endif %}
241   RETURN parent_place_id;
242 END;
243 $$
244 LANGUAGE plpgsql STABLE;
245
246
247 CREATE OR REPLACE FUNCTION delete_location(OLD_place_id BIGINT)
248   RETURNS BOOLEAN
249   AS $$
250 DECLARE
251 BEGIN
252   DELETE FROM location_area where place_id = OLD_place_id;
253 -- TODO:location_area
254   RETURN true;
255 END;
256 $$
257 LANGUAGE plpgsql;
258
259 -- Create a bounding box with an extent computed from the radius (in meters)
260 -- which in turn is derived from the given search rank.
261 CREATE OR REPLACE FUNCTION place_node_fuzzy_area(geom GEOMETRY, rank_search INTEGER)
262   RETURNS GEOMETRY
263   AS $$
264 DECLARE
265   radius FLOAT := 500;
266 BEGIN
267   IF rank_search <= 16 THEN -- city
268     radius := 15000;
269   ELSIF rank_search <= 18 THEN -- town
270     radius := 4000;
271   ELSIF rank_search <= 19 THEN -- village
272     radius := 2000;
273   ELSIF rank_search  <= 20 THEN -- hamlet
274     radius := 1000;
275   END IF;
276
277   RETURN ST_Envelope(ST_Collect(
278                      ST_Project(geom, radius, 0.785398)::geometry,
279                      ST_Project(geom, radius, 3.9269908)::geometry));
280 END;
281 $$
282 LANGUAGE plpgsql IMMUTABLE;
283
284
285 CREATE OR REPLACE FUNCTION add_location(place_id BIGINT, country_code varchar(2),
286                                         partition INTEGER, keywords INTEGER[],
287                                         rank_search INTEGER, rank_address INTEGER,
288                                         in_postcode TEXT, geometry GEOMETRY,
289                                         centroid GEOMETRY)
290   RETURNS BOOLEAN
291   AS $$
292 DECLARE
293   locationid INTEGER;
294   secgeo GEOMETRY;
295   postcode TEXT;
296 BEGIN
297   PERFORM deleteLocationArea(partition, place_id, rank_search);
298
299   -- add postcode only if it contains a single entry, i.e. ignore postcode lists
300   postcode := NULL;
301   IF in_postcode is not null AND in_postcode not similar to '%(,|;)%' THEN
302       postcode := upper(trim (in_postcode));
303   END IF;
304
305   IF ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon') THEN
306     FOR secgeo IN select split_geometry(geometry) AS geom LOOP
307       PERFORM insertLocationAreaLarge(partition, place_id, country_code, keywords, rank_search, rank_address, false, postcode, centroid, secgeo);
308     END LOOP;
309
310   ELSEIF ST_GeometryType(geometry) = 'ST_Point' THEN
311     secgeo := place_node_fuzzy_area(geometry, rank_search);
312     PERFORM insertLocationAreaLarge(partition, place_id, country_code, keywords, rank_search, rank_address, true, postcode, centroid, secgeo);
313
314   END IF;
315
316   RETURN true;
317 END;
318 $$
319 LANGUAGE plpgsql;
320
321
322 CREATE OR REPLACE FUNCTION quad_split_geometry(geometry GEOMETRY, maxarea FLOAT,
323                                                maxdepth INTEGER)
324   RETURNS SETOF GEOMETRY
325   AS $$
326 DECLARE
327   xmin FLOAT;
328   ymin FLOAT;
329   xmax FLOAT;
330   ymax FLOAT;
331   xmid FLOAT;
332   ymid FLOAT;
333   secgeo GEOMETRY;
334   secbox GEOMETRY;
335   seg INTEGER;
336   geo RECORD;
337   area FLOAT;
338   remainingdepth INTEGER;
339   added INTEGER;
340 BEGIN
341
342 --  RAISE WARNING 'quad_split_geometry: maxarea=%, depth=%',maxarea,maxdepth;
343
344   IF (ST_GeometryType(geometry) not in ('ST_Polygon','ST_MultiPolygon') OR NOT ST_IsValid(geometry)) THEN
345     RETURN NEXT geometry;
346     RETURN;
347   END IF;
348
349   remainingdepth := maxdepth - 1;
350   area := ST_AREA(geometry);
351   IF remainingdepth < 1 OR area < maxarea THEN
352     RETURN NEXT geometry;
353     RETURN;
354   END IF;
355
356   xmin := st_xmin(geometry);
357   xmax := st_xmax(geometry);
358   ymin := st_ymin(geometry);
359   ymax := st_ymax(geometry);
360   secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(ymin,xmin),ST_Point(ymax,xmax)),4326);
361
362   -- if the geometry completely covers the box don't bother to slice any more
363   IF ST_AREA(secbox) = area THEN
364     RETURN NEXT geometry;
365     RETURN;
366   END IF;
367
368   xmid := (xmin+xmax)/2;
369   ymid := (ymin+ymax)/2;
370
371   added := 0;
372   FOR seg IN 1..4 LOOP
373
374     IF seg = 1 THEN
375       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmin,ymin),ST_Point(xmid,ymid)),4326);
376     END IF;
377     IF seg = 2 THEN
378       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmin,ymid),ST_Point(xmid,ymax)),4326);
379     END IF;
380     IF seg = 3 THEN
381       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmid,ymin),ST_Point(xmax,ymid)),4326);
382     END IF;
383     IF seg = 4 THEN
384       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmid,ymid),ST_Point(xmax,ymax)),4326);
385     END IF;
386
387     IF st_intersects(geometry, secbox) THEN
388       secgeo := st_intersection(geometry, secbox);
389       IF NOT ST_IsEmpty(secgeo) AND ST_GeometryType(secgeo) in ('ST_Polygon','ST_MultiPolygon') THEN
390         FOR geo IN select quad_split_geometry(secgeo, maxarea, remainingdepth) as geom LOOP
391           IF NOT ST_IsEmpty(geo.geom) AND ST_GeometryType(geo.geom) in ('ST_Polygon','ST_MultiPolygon') THEN
392             added := added + 1;
393             RETURN NEXT geo.geom;
394           END IF;
395         END LOOP;
396       END IF;
397     END IF;
398   END LOOP;
399
400   RETURN;
401 END;
402 $$
403 LANGUAGE plpgsql IMMUTABLE;
404
405
406 CREATE OR REPLACE FUNCTION split_geometry(geometry GEOMETRY)
407   RETURNS SETOF GEOMETRY
408   AS $$
409 DECLARE
410   geo RECORD;
411 BEGIN
412   -- 10000000000 is ~~ 1x1 degree
413   FOR geo IN select quad_split_geometry(geometry, 0.25, 20) as geom LOOP
414     RETURN NEXT geo.geom;
415   END LOOP;
416   RETURN;
417 END;
418 $$
419 LANGUAGE plpgsql IMMUTABLE;
420
421
422 CREATE OR REPLACE FUNCTION place_force_delete(placeid BIGINT)
423   RETURNS BOOLEAN
424   AS $$
425 DECLARE
426     osmid BIGINT;
427     osmtype character(1);
428     pclass text;
429     ptype text;
430 BEGIN
431   SELECT osm_type, osm_id, class, type FROM placex WHERE place_id = placeid INTO osmtype, osmid, pclass, ptype;
432   DELETE FROM import_polygon_delete where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
433   DELETE FROM import_polygon_error where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
434   -- force delete from place/placex by making it a very small geometry
435   UPDATE place set geometry = ST_SetSRID(ST_Point(0,0), 4326) where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
436   DELETE FROM place where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
437
438   RETURN TRUE;
439 END;
440 $$
441 LANGUAGE plpgsql;
442
443
444 CREATE OR REPLACE FUNCTION place_force_update(placeid BIGINT)
445   RETURNS BOOLEAN
446   AS $$
447 DECLARE
448   placegeom GEOMETRY;
449   geom GEOMETRY;
450   diameter FLOAT;
451   rank SMALLINT;
452 BEGIN
453   UPDATE placex SET indexed_status = 2 WHERE place_id = placeid;
454
455   SELECT geometry, rank_address INTO placegeom, rank
456     FROM placex WHERE place_id = placeid;
457
458   IF placegeom IS NOT NULL AND ST_IsValid(placegeom) THEN
459     IF ST_GeometryType(placegeom) in ('ST_Polygon','ST_MultiPolygon')
460        AND rank > 0
461     THEN
462       FOR geom IN SELECT split_geometry(placegeom) LOOP
463         UPDATE placex SET indexed_status = 2
464          WHERE ST_Intersects(geom, placex.geometry)
465                and indexed_status = 0
466                and ((rank_address = 0 and rank_search > rank) or rank_address > rank)
467                and (rank_search < 28 or name is not null or (rank >= 16 and address ? 'place'));
468       END LOOP;
469     ELSE
470         diameter := update_place_diameter(rank);
471         IF diameter > 0 THEN
472           IF rank >= 26 THEN
473             -- roads may cause reparenting for >27 rank places
474             update placex set indexed_status = 2 where indexed_status = 0 and rank_search > rank and ST_DWithin(placex.geometry, placegeom, diameter);
475           ELSEIF rank >= 16 THEN
476             -- up to rank 16, street-less addresses may need reparenting
477             update placex set indexed_status = 2 where indexed_status = 0 and rank_search > rank and ST_DWithin(placex.geometry, placegeom, diameter) and (rank_search < 28 or name is not null or address ? 'place');
478           ELSE
479             -- for all other places the search terms may change as well
480             update placex set indexed_status = 2 where indexed_status = 0 and rank_search > rank and ST_DWithin(placex.geometry, placegeom, diameter) and (rank_search < 28 or name is not null);
481           END IF;
482         END IF;
483     END IF;
484     RETURN TRUE;
485   END IF;
486
487   RETURN FALSE;
488 END;
489 $$
490 LANGUAGE plpgsql;