]> git.openstreetmap.org Git - nominatim.git/blob - sql/functions/utils.sql
6371e9adb739f3fdb7e868219fed02ca9804c7dd
[nominatim.git] / 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
42 CREATE OR REPLACE FUNCTION reverse_place_diameter(rank_search SMALLINT)
43   RETURNS FLOAT
44   AS $$
45 BEGIN
46   IF rank_search <= 4 THEN
47     RETURN 5.0;
48   ELSIF rank_search <= 8 THEN
49     RETURN 1.8;
50   ELSIF rank_search <= 12 THEN
51     RETURN 0.6;
52   ELSIF rank_search <= 17 THEN
53     RETURN 0.16;
54   ELSIF rank_search <= 18 THEN
55     RETURN 0.08;
56   ELSIF rank_search <= 19 THEN
57     RETURN 0.04;
58   END IF;
59
60   RETURN 0.02;
61 END;
62 $$
63 LANGUAGE plpgsql IMMUTABLE;
64
65
66 CREATE OR REPLACE FUNCTION get_postcode_rank(country_code VARCHAR(2), postcode TEXT,
67                                              OUT rank_search SMALLINT,
68                                              OUT rank_address SMALLINT)
69 AS $$
70 DECLARE
71   part TEXT;
72 BEGIN
73     rank_search := 30;
74     rank_address := 30;
75     postcode := upper(postcode);
76
77     IF country_code = 'gb' THEN
78         IF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z]? [0-9][A-Z][A-Z])$' THEN
79             rank_search := 25;
80             rank_address := 5;
81         ELSEIF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z]? [0-9])$' THEN
82             rank_search := 23;
83             rank_address := 5;
84         ELSEIF postcode ~ '^([A-Z][A-Z]?[0-9][0-9A-Z])$' THEN
85             rank_search := 21;
86             rank_address := 5;
87         END IF;
88
89     ELSEIF country_code = 'sg' THEN
90         IF postcode ~ '^([0-9]{6})$' THEN
91             rank_search := 25;
92             rank_address := 11;
93         END IF;
94
95     ELSEIF country_code = 'de' THEN
96         IF postcode ~ '^([0-9]{5})$' THEN
97             rank_search := 21;
98             rank_address := 11;
99         END IF;
100
101     ELSE
102         -- Guess at the postcode format and coverage (!)
103         IF postcode ~ '^[A-Z0-9]{1,5}$' THEN -- Probably too short to be very local
104             rank_search := 21;
105             rank_address := 11;
106         ELSE
107             -- Does it look splitable into and area and local code?
108             part := substring(postcode from '^([- :A-Z0-9]+)([- :][A-Z0-9]+)$');
109
110             IF part IS NOT NULL THEN
111                 rank_search := 25;
112                 rank_address := 11;
113             ELSEIF postcode ~ '^[- :A-Z0-9]{6,}$' THEN
114                 rank_search := 21;
115                 rank_address := 11;
116             END IF;
117         END IF;
118     END IF;
119
120 END;
121 $$
122 LANGUAGE plpgsql IMMUTABLE;
123
124
125 -- Find the nearest artificial postcode for the given geometry.
126 -- TODO For areas there should not be more than two inside the geometry.
127 CREATE OR REPLACE FUNCTION get_nearest_postcode(country VARCHAR(2), geom GEOMETRY)
128   RETURNS TEXT
129   AS $$
130 DECLARE
131   outcode TEXT;
132   cnt INTEGER;
133 BEGIN
134     -- If the geometry is an area then only one postcode must be within
135     -- that area, otherwise consider the area as not having a postcode.
136     IF ST_GeometryType(geom) in ('ST_Polygon','ST_MultiPolygon') THEN
137         SELECT min(postcode), count(*) FROM
138               (SELECT postcode FROM location_postcode
139                 WHERE ST_Contains(geom, location_postcode.geometry) LIMIT 2) sub
140           INTO outcode, cnt;
141
142         IF cnt = 1 THEN
143             RETURN outcode;
144         ELSE
145             RETURN null;
146         END IF;
147     END IF;
148
149     SELECT postcode FROM location_postcode
150      WHERE ST_DWithin(geom, location_postcode.geometry, 0.05)
151           AND location_postcode.country_code = country
152      ORDER BY ST_Distance(geom, location_postcode.geometry) LIMIT 1
153     INTO outcode;
154
155     RETURN outcode;
156 END;
157 $$
158 LANGUAGE plpgsql STABLE;
159
160
161 CREATE OR REPLACE FUNCTION get_country_code(place geometry)
162   RETURNS TEXT
163   AS $$
164 DECLARE
165   place_centre GEOMETRY;
166   nearcountry RECORD;
167 BEGIN
168   place_centre := ST_PointOnSurface(place);
169
170 -- RAISE WARNING 'get_country_code, start: %', ST_AsText(place_centre);
171
172   -- Try for a OSM polygon
173   FOR nearcountry IN
174     SELECT country_code from location_area_country
175     WHERE country_code is not null and st_covers(geometry, place_centre) limit 1
176   LOOP
177     RETURN nearcountry.country_code;
178   END LOOP;
179
180 -- RAISE WARNING 'osm fallback: %', ST_AsText(place_centre);
181
182   -- Try for OSM fallback data
183   -- The order is to deal with places like HongKong that are 'states' within another polygon
184   FOR nearcountry IN
185     SELECT country_code from country_osm_grid
186     WHERE st_covers(geometry, place_centre) order by area asc limit 1
187   LOOP
188     RETURN nearcountry.country_code;
189   END LOOP;
190
191 -- RAISE WARNING 'near osm fallback: %', ST_AsText(place_centre);
192
193   -- 
194   FOR nearcountry IN
195     SELECT country_code from country_osm_grid
196     WHERE st_dwithin(geometry, place_centre, 0.5)
197     ORDER BY st_distance(geometry, place_centre) asc, area asc limit 1
198   LOOP
199     RETURN nearcountry.country_code;
200   END LOOP;
201
202   RETURN NULL;
203 END;
204 $$
205 LANGUAGE plpgsql STABLE;
206
207
208 CREATE OR REPLACE FUNCTION get_country_language_code(search_country_code VARCHAR(2))
209   RETURNS TEXT
210   AS $$
211 DECLARE
212   nearcountry RECORD;
213 BEGIN
214   FOR nearcountry IN
215     SELECT distinct country_default_language_code from country_name
216     WHERE country_code = search_country_code limit 1
217   LOOP
218     RETURN lower(nearcountry.country_default_language_code);
219   END LOOP;
220   RETURN NULL;
221 END;
222 $$
223 LANGUAGE plpgsql STABLE;
224
225
226 CREATE OR REPLACE FUNCTION get_partition(in_country_code VARCHAR(10))
227   RETURNS INTEGER
228   AS $$
229 DECLARE
230   nearcountry RECORD;
231 BEGIN
232   FOR nearcountry IN
233     SELECT partition from country_name where country_code = in_country_code
234   LOOP
235     RETURN nearcountry.partition;
236   END LOOP;
237   RETURN 0;
238 END;
239 $$
240 LANGUAGE plpgsql STABLE;
241
242
243 -- Find the parent of an address with addr:street/addr:place tag.
244 --
245 -- \param street     Value of addr:street or NULL if tag is missing.
246 -- \param place      Value of addr:place or NULL if tag is missing.
247 -- \param partition  Partition where to search the parent.
248 -- \param centroid   Location of the address.
249 --
250 -- \return Place ID of the parent if one was found, NULL otherwise.
251 CREATE OR REPLACE FUNCTION find_parent_for_address(street TEXT, place TEXT,
252                                                    partition SMALLINT,
253                                                    centroid GEOMETRY)
254   RETURNS BIGINT
255   AS $$
256 DECLARE
257   parent_place_id BIGINT;
258   word_ids INTEGER[];
259 BEGIN
260   IF street is not null THEN
261     -- Check for addr:street attributes
262     -- Note that addr:street links can only be indexed, once the street itself is indexed
263     word_ids := word_ids_from_name(street);
264     IF word_ids is not null THEN
265       parent_place_id := getNearestNamedRoadPlaceId(partition, centroid, word_ids);
266       IF parent_place_id is not null THEN
267         --DEBUG: RAISE WARNING 'Get parent form addr:street: %', parent.place_id;
268         RETURN parent_place_id;
269       END IF;
270     END IF;
271   END IF;
272
273   -- Check for addr:place attributes.
274   IF place is not null THEN
275     word_ids := word_ids_from_name(place);
276     IF word_ids is not null THEN
277       parent_place_id := getNearestNamedPlacePlaceId(partition, centroid, word_ids);
278       IF parent_place_id is not null THEN
279         --DEBUG: RAISE WARNING 'Get parent form addr:place: %', parent.place_id;
280         RETURN parent_place_id;
281       END IF;
282     END IF;
283   END IF;
284
285   RETURN NULL;
286 END;
287 $$
288 LANGUAGE plpgsql STABLE;
289
290 CREATE OR REPLACE FUNCTION delete_location(OLD_place_id BIGINT)
291   RETURNS BOOLEAN
292   AS $$
293 DECLARE
294 BEGIN
295   DELETE FROM location_area where place_id = OLD_place_id;
296 -- TODO:location_area
297   RETURN true;
298 END;
299 $$
300 LANGUAGE plpgsql;
301
302
303 CREATE OR REPLACE FUNCTION add_location(place_id BIGINT, country_code varchar(2),
304                                         partition INTEGER, keywords INTEGER[],
305                                         rank_search INTEGER, rank_address INTEGER,
306                                         in_postcode TEXT, geometry GEOMETRY)
307   RETURNS BOOLEAN
308   AS $$
309 DECLARE
310   locationid INTEGER;
311   centroid GEOMETRY;
312   diameter FLOAT;
313   x BOOLEAN;
314   splitGeom RECORD;
315   secgeo GEOMETRY;
316   postcode TEXT;
317 BEGIN
318
319   IF rank_search > 25 THEN
320     RAISE EXCEPTION 'Adding location with rank > 25 (% rank %)', place_id, rank_search;
321   END IF;
322
323   x := deleteLocationArea(partition, place_id, rank_search);
324
325   -- add postcode only if it contains a single entry, i.e. ignore postcode lists
326   postcode := NULL;
327   IF in_postcode is not null AND in_postcode not similar to '%(,|;)%' THEN
328       postcode := upper(trim (in_postcode));
329   END IF;
330
331   IF ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon') THEN
332     centroid := ST_Centroid(geometry);
333
334     FOR secgeo IN select split_geometry(geometry) AS geom LOOP
335       x := insertLocationAreaLarge(partition, place_id, country_code, keywords, rank_search, rank_address, false, postcode, centroid, secgeo);
336     END LOOP;
337
338   ELSE
339
340     diameter := 0.02;
341     IF rank_address = 0 THEN
342       diameter := 0.02;
343     ELSEIF rank_search <= 14 THEN
344       diameter := 1.2;
345     ELSEIF rank_search <= 15 THEN
346       diameter := 1;
347     ELSEIF rank_search <= 16 THEN
348       diameter := 0.5;
349     ELSEIF rank_search <= 17 THEN
350       diameter := 0.2;
351     ELSEIF rank_search <= 21 THEN
352       diameter := 0.05;
353     ELSEIF rank_search = 25 THEN
354       diameter := 0.005;
355     END IF;
356
357 --    RAISE WARNING 'adding % diameter %', place_id, diameter;
358
359     secgeo := ST_Buffer(geometry, diameter);
360     x := insertLocationAreaLarge(partition, place_id, country_code, keywords, rank_search, rank_address, true, postcode, ST_Centroid(geometry), secgeo);
361
362   END IF;
363
364   RETURN true;
365 END;
366 $$
367 LANGUAGE plpgsql;
368
369
370 CREATE OR REPLACE FUNCTION quad_split_geometry(geometry GEOMETRY, maxarea FLOAT,
371                                                maxdepth INTEGER)
372   RETURNS SETOF GEOMETRY
373   AS $$
374 DECLARE
375   xmin FLOAT;
376   ymin FLOAT;
377   xmax FLOAT;
378   ymax FLOAT;
379   xmid FLOAT;
380   ymid FLOAT;
381   secgeo GEOMETRY;
382   secbox GEOMETRY;
383   seg INTEGER;
384   geo RECORD;
385   area FLOAT;
386   remainingdepth INTEGER;
387   added INTEGER;
388 BEGIN
389
390 --  RAISE WARNING 'quad_split_geometry: maxarea=%, depth=%',maxarea,maxdepth;
391
392   IF (ST_GeometryType(geometry) not in ('ST_Polygon','ST_MultiPolygon') OR NOT ST_IsValid(geometry)) THEN
393     RETURN NEXT geometry;
394     RETURN;
395   END IF;
396
397   remainingdepth := maxdepth - 1;
398   area := ST_AREA(geometry);
399   IF remainingdepth < 1 OR area < maxarea THEN
400     RETURN NEXT geometry;
401     RETURN;
402   END IF;
403
404   xmin := st_xmin(geometry);
405   xmax := st_xmax(geometry);
406   ymin := st_ymin(geometry);
407   ymax := st_ymax(geometry);
408   secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(ymin,xmin),ST_Point(ymax,xmax)),4326);
409
410   -- if the geometry completely covers the box don't bother to slice any more
411   IF ST_AREA(secbox) = area THEN
412     RETURN NEXT geometry;
413     RETURN;
414   END IF;
415
416   xmid := (xmin+xmax)/2;
417   ymid := (ymin+ymax)/2;
418
419   added := 0;
420   FOR seg IN 1..4 LOOP
421
422     IF seg = 1 THEN
423       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmin,ymin),ST_Point(xmid,ymid)),4326);
424     END IF;
425     IF seg = 2 THEN
426       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmin,ymid),ST_Point(xmid,ymax)),4326);
427     END IF;
428     IF seg = 3 THEN
429       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmid,ymin),ST_Point(xmax,ymid)),4326);
430     END IF;
431     IF seg = 4 THEN
432       secbox := ST_SetSRID(ST_MakeBox2D(ST_Point(xmid,ymid),ST_Point(xmax,ymax)),4326);
433     END IF;
434
435     IF st_intersects(geometry, secbox) THEN
436       secgeo := st_intersection(geometry, secbox);
437       IF NOT ST_IsEmpty(secgeo) AND ST_GeometryType(secgeo) in ('ST_Polygon','ST_MultiPolygon') THEN
438         FOR geo IN select quad_split_geometry(secgeo, maxarea, remainingdepth) as geom LOOP
439           IF NOT ST_IsEmpty(geo.geom) AND ST_GeometryType(geo.geom) in ('ST_Polygon','ST_MultiPolygon') THEN
440             added := added + 1;
441             RETURN NEXT geo.geom;
442           END IF;
443         END LOOP;
444       END IF;
445     END IF;
446   END LOOP;
447
448   RETURN;
449 END;
450 $$
451 LANGUAGE plpgsql IMMUTABLE;
452
453
454 CREATE OR REPLACE FUNCTION split_geometry(geometry GEOMETRY)
455   RETURNS SETOF GEOMETRY
456   AS $$
457 DECLARE
458   geo RECORD;
459 BEGIN
460   -- 10000000000 is ~~ 1x1 degree
461   FOR geo IN select quad_split_geometry(geometry, 0.25, 20) as geom LOOP
462     RETURN NEXT geo.geom;
463   END LOOP;
464   RETURN;
465 END;
466 $$
467 LANGUAGE plpgsql IMMUTABLE;
468
469
470 CREATE OR REPLACE FUNCTION place_force_delete(placeid BIGINT)
471   RETURNS BOOLEAN
472   AS $$
473 DECLARE
474     osmid BIGINT;
475     osmtype character(1);
476     pclass text;
477     ptype text;
478 BEGIN
479   SELECT osm_type, osm_id, class, type FROM placex WHERE place_id = placeid INTO osmtype, osmid, pclass, ptype;
480   DELETE FROM import_polygon_delete where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
481   DELETE FROM import_polygon_error where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
482   -- force delete from place/placex by making it a very small geometry
483   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;
484   DELETE FROM place where osm_type = osmtype and osm_id = osmid and class = pclass and type = ptype;
485
486   RETURN TRUE;
487 END;
488 $$
489 LANGUAGE plpgsql;
490
491
492 CREATE OR REPLACE FUNCTION place_force_update(placeid BIGINT)
493   RETURNS BOOLEAN
494   AS $$
495 DECLARE
496   placegeom GEOMETRY;
497   geom GEOMETRY;
498   diameter FLOAT;
499   rank INTEGER;
500 BEGIN
501   UPDATE placex SET indexed_status = 2 WHERE place_id = placeid;
502   SELECT geometry, rank_search FROM placex WHERE place_id = placeid INTO placegeom, rank;
503   IF placegeom IS NOT NULL AND ST_IsValid(placegeom) THEN
504     IF ST_GeometryType(placegeom) in ('ST_Polygon','ST_MultiPolygon') THEN
505       FOR geom IN select split_geometry(placegeom) FROM placex WHERE place_id = placeid LOOP
506         update placex set indexed_status = 2 where (st_covers(geom, placex.geometry) OR ST_Intersects(geom, placex.geometry)) 
507         AND rank_search > rank and indexed_status = 0 and ST_geometrytype(placex.geometry) = 'ST_Point' and (rank_search < 28 or name is not null or (rank >= 16 and address ? 'place'));
508         update placex set indexed_status = 2 where (st_covers(geom, placex.geometry) OR ST_Intersects(geom, placex.geometry)) 
509         AND rank_search > rank and indexed_status = 0 and ST_geometrytype(placex.geometry) != 'ST_Point' and (rank_search < 28 or name is not null or (rank >= 16 and address ? 'place'));
510       END LOOP;
511     ELSE
512         diameter := 0;
513         IF rank = 11 THEN
514           diameter := 0.05;
515         ELSEIF rank < 18 THEN
516           diameter := 0.1;
517         ELSEIF rank < 20 THEN
518           diameter := 0.05;
519         ELSEIF rank = 21 THEN
520           diameter := 0.001;
521         ELSEIF rank < 24 THEN
522           diameter := 0.02;
523         ELSEIF rank < 26 THEN
524           diameter := 0.002; -- 100 to 200 meters
525         ELSEIF rank < 28 THEN
526           diameter := 0.001; -- 50 to 100 meters
527         END IF;
528         IF diameter > 0 THEN
529           IF rank >= 26 THEN
530             -- roads may cause reparenting for >27 rank places
531             update placex set indexed_status = 2 where indexed_status = 0 and rank_search > rank and ST_DWithin(placex.geometry, placegeom, diameter);
532           ELSEIF rank >= 16 THEN
533             -- up to rank 16, street-less addresses may need reparenting
534             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');
535           ELSE
536             -- for all other places the search terms may change as well
537             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);
538           END IF;
539         END IF;
540     END IF;
541     RETURN TRUE;
542   END IF;
543
544   RETURN FALSE;
545 END;
546 $$
547 LANGUAGE plpgsql;