sql/functions/address_lookup.sql

   1 -- Functions for returning address information for a place.
   2
   3 DROP TYPE IF EXISTS addressline CASCADE;
   4 CREATE TYPE addressline as (
   5   place_id BIGINT,
   6   osm_type CHAR(1),
   7   osm_id BIGINT,
   8   name HSTORE,
   9   class TEXT,
  10   type TEXT,
  11   place_type TEXT,
  12   admin_level INTEGER,
  13   fromarea BOOLEAN,
  14   isaddress BOOLEAN,
  15   rank_address INTEGER,
  16   distance FLOAT
  17 );
  18
  19
  20 CREATE OR REPLACE FUNCTION get_name_by_language(name hstore, languagepref TEXT[])
  21   RETURNS TEXT
  22   AS $$
  23 DECLARE
  24   result TEXT;
  25 BEGIN
  26   IF name is null THEN
  27     RETURN null;
  28   END IF;
  29
  30   FOR j IN 1..array_upper(languagepref,1) LOOP
  31     IF name ? languagepref[j] THEN
  32       result := trim(name->languagepref[j]);
  33       IF result != '' THEN
  34         return result;
  35       END IF;
  36     END IF;
  37   END LOOP;
  38
  39   -- anything will do as a fallback - just take the first name type thing there is
  40   RETURN trim((avals(name))[1]);
  41 END;
  42 $$
  43 LANGUAGE plpgsql IMMUTABLE;
  44
  45
  46 --housenumber only needed for tiger data
  47 CREATE OR REPLACE FUNCTION get_address_by_language(for_place_id BIGINT,
  48                                                    housenumber INTEGER,
  49                                                    languagepref TEXT[])
  50   RETURNS TEXT
  51   AS $$
  52 DECLARE
  53   result TEXT[];
  54   currresult TEXT;
  55   prevresult TEXT;
  56   location RECORD;
  57 BEGIN
  58
  59   result := '{}';
  60   prevresult := '';
  61
  62   FOR location IN
  63     SELECT name,
  64        CASE WHEN place_id = for_place_id THEN 99 ELSE rank_address END as rank_address
  65     FROM get_addressdata(for_place_id, housenumber)
  66     WHERE isaddress order by rank_address desc
  67   LOOP
  68     currresult := trim(get_name_by_language(location.name, languagepref));
  69     IF currresult != prevresult AND currresult IS NOT NULL
  70        AND result[(100 - location.rank_address)] IS NULL
  71     THEN
  72       result[(100 - location.rank_address)] := currresult;
  73       prevresult := currresult;
  74     END IF;
  75   END LOOP;
  76
  77   RETURN array_to_string(result,', ');
  78 END;
  79 $$
  80 LANGUAGE plpgsql STABLE;
  81
  82
  83 -- Compute the list of address parts for the given place.
  84 --
  85 -- If in_housenumber is greator or equal 0, look for an interpolation.
  86 CREATE OR REPLACE FUNCTION get_addressdata(in_place_id BIGINT, in_housenumber INTEGER)
  87   RETURNS setof addressline
  88   AS $$
  89 DECLARE
  90   for_place_id BIGINT;
  91   result TEXT[];
  92   search TEXT[];
  93   found INTEGER;
  94   location RECORD;
  95   countrylocation RECORD;
  96   searchcountrycode varchar(2);
  97   searchhousenumber TEXT;
  98   searchhousename HSTORE;
  99   searchpostcode TEXT;
 100   postcode_isexact BOOL;
 101   searchclass TEXT;
 102   searchtype TEXT;
 103   search_unlisted_place TEXT;
 104   countryname HSTORE;
 105 BEGIN
 106   -- The place ein question might not have a direct entry in place_addressline.
 107   -- Look for the parent of such places then and save if in for_place_id.
 108
 109   postcode_isexact := false;
 110
 111   -- first query osmline (interpolation lines)
 112   IF in_housenumber >= 0 THEN
 113     SELECT parent_place_id, country_code, in_housenumber::text, postcode,
 114            null, 'place', 'house'
 115       FROM location_property_osmline
 116       WHERE place_id = in_place_id AND in_housenumber>=startnumber
 117             AND in_housenumber <= endnumber
 118       INTO for_place_id, searchcountrycode, searchhousenumber,
 119            searchpostcode, searchhousename, searchclass, searchtype;
 120   END IF;
 121
 122   --then query tiger data
 123   -- %NOTIGERDATA% IF 0 THEN
 124   IF for_place_id IS NULL AND in_housenumber >= 0 THEN
 125     SELECT parent_place_id, 'us', in_housenumber::text, postcode, null,
 126            'place', 'house'
 127       FROM location_property_tiger
 128       WHERE place_id = in_place_id AND in_housenumber >= startnumber
 129             AND in_housenumber <= endnumber
 130       INTO for_place_id, searchcountrycode, searchhousenumber,
 131            searchpostcode, searchhousename, searchclass, searchtype;
 132   END IF;
 133   -- %NOTIGERDATA% END IF;
 134
 135   -- %NOAUXDATA% IF 0 THEN
 136   IF for_place_id IS NULL THEN
 137     SELECT parent_place_id, 'us', housenumber, postcode, null, 'place', 'house'
 138       FROM location_property_aux
 139       WHERE place_id = in_place_id
 140       INTO for_place_id,searchcountrycode, searchhousenumber,
 141            searchpostcode, searchhousename, searchclass, searchtype;
 142   END IF;
 143   -- %NOAUXDATA% END IF;
 144
 145   -- postcode table
 146   IF for_place_id IS NULL THEN
 147     SELECT parent_place_id, country_code, postcode, 'place', 'postcode'
 148       FROM location_postcode
 149       WHERE place_id = in_place_id
 150       INTO for_place_id, searchcountrycode, searchpostcode,
 151            searchclass, searchtype;
 152   END IF;
 153
 154   -- POI objects in the placex table
 155   IF for_place_id IS NULL THEN
 156     SELECT parent_place_id, country_code, housenumber,
 157            postcode, address is not null and address ? 'postcode',
 158            name, class, type,
 159            address -> '_unlisted_place' as unlisted_place
 160       FROM placex
 161       WHERE place_id = in_place_id and rank_search > 27
 162       INTO for_place_id, searchcountrycode, searchhousenumber,
 163            searchpostcode, postcode_isexact, searchhousename, searchclass,
 164            searchtype, search_unlisted_place;
 165   END IF;
 166
 167   -- If for_place_id is still NULL at this point then the object has its own
 168   -- entry in place_address line. However, still check if there is not linked
 169   -- place we should be using instead.
 170   IF for_place_id IS NULL THEN
 171     select coalesce(linked_place_id, place_id),  country_code,
 172            housenumber, postcode,
 173            address is not null and address ? 'postcode', null
 174       from placex where place_id = in_place_id
 175       INTO for_place_id, searchcountrycode, searchhousenumber, searchpostcode, postcode_isexact, searchhousename;
 176   END IF;
 177
 178 --RAISE WARNING '% % % %',searchcountrycode, searchhousenumber, searchpostcode;
 179
 180   found := 1000; -- the lowest rank_address included
 181
 182   -- Return the record for the base entry.
 183   FOR location IN
 184     SELECT placex.place_id, osm_type, osm_id, name,
 185            coalesce(extratags->'linked_place', extratags->'place') as place_type,
 186            class, type, admin_level,
 187            type not in ('postcode', 'postal_code') as isaddress,
 188            CASE WHEN rank_address = 0 THEN 100
 189                 WHEN rank_address = 11 THEN 5
 190                 ELSE rank_address END as rank_address,
 191            0 as distance, country_code, postcode
 192       FROM placex
 193       WHERE place_id = for_place_id
 194   LOOP
 195 --RAISE WARNING '%',location;
 196     IF searchcountrycode IS NULL AND location.country_code IS NOT NULL THEN
 197       searchcountrycode := location.country_code;
 198     END IF;
 199     IF location.rank_address < 4 THEN
 200       -- no country locations for ranks higher than country
 201       searchcountrycode := NULL;
 202     END IF;
 203     countrylocation := ROW(location.place_id, location.osm_type, location.osm_id,
 204                            location.name, location.class, location.type,
 205                            location.place_type,
 206                            location.admin_level, true, location.isaddress,
 207                            location.rank_address, location.distance)::addressline;
 208     RETURN NEXT countrylocation;
 209     found := location.rank_address;
 210   END LOOP;
 211
 212   FOR location IN
 213     SELECT placex.place_id, osm_type, osm_id, name, class, type,
 214            coalesce(extratags->'linked_place', extratags->'place') as place_type,
 215            admin_level, fromarea, isaddress and linked_place_id is NULL as isaddress,
 216            CASE WHEN rank_address = 11 THEN 5 ELSE rank_address END as rank_address,
 217            distance, country_code, postcode
 218       FROM place_addressline join placex on (address_place_id = placex.place_id)
 219       WHERE place_addressline.place_id = for_place_id
 220             AND linked_place_id is null
 221             AND (placex.country_code IS NULL OR searchcountrycode IS NULL
 222                  OR placex.country_code = searchcountrycode)
 223       ORDER BY rank_address desc, isaddress desc, fromarea desc,
 224                distance asc, rank_search desc
 225   LOOP
 226 --RAISE WARNING '%',location;
 227     IF searchcountrycode IS NULL AND location.country_code IS NOT NULL THEN
 228       searchcountrycode := location.country_code;
 229     END IF;
 230     IF location.type in ('postcode', 'postal_code')
 231        AND searchpostcode is not null
 232     THEN
 233       -- If the place had a postcode assigned, take this one only
 234       -- into consideration when it is an area and the place does not have
 235       -- a postcode itself.
 236       IF location.fromarea AND not postcode_isexact AND location.isaddress THEN
 237         searchpostcode := null; -- remove the less exact postcode
 238       ELSE
 239         location.isaddress := false;
 240       END IF;
 241     END IF;
 242     countrylocation := ROW(location.place_id, location.osm_type, location.osm_id,
 243                            location.name, location.class, location.type,
 244                            location.place_type,
 245                            location.admin_level, location.fromarea,
 246                            location.isaddress, location.rank_address,
 247                            location.distance)::addressline;
 248     RETURN NEXT countrylocation;
 249     found := location.rank_address;
 250   END LOOP;
 251
 252   -- If no country was included yet, add the name information from country_name.
 253   IF found > 4 THEN
 254     SELECT name FROM country_name
 255       WHERE country_code = searchcountrycode LIMIT 1 INTO countryname;
 256 --RAISE WARNING '% % %',found,searchcountrycode,countryname;
 257     IF countryname IS NOT NULL THEN
 258       location := ROW(null, null, null, countryname, 'place', 'country', NULL,
 259                       null, true, true, 4, 0)::addressline;
 260       RETURN NEXT location;
 261     END IF;
 262   END IF;
 263
 264   -- Finally add some artificial rows.
 265   IF searchcountrycode IS NOT NULL THEN
 266     location := ROW(null, null, null, hstore('ref', searchcountrycode),
 267                     'place', 'country_code', null, null, true, false, 4, 0)::addressline;
 268     RETURN NEXT location;
 269   END IF;
 270
 271   IF searchhousename IS NOT NULL THEN
 272     location := ROW(in_place_id, null, null, searchhousename, searchclass,
 273                     searchtype, null, null, true, true, 29, 0)::addressline;
 274     RETURN NEXT location;
 275   END IF;
 276
 277   IF searchhousenumber IS NOT NULL THEN
 278     location := ROW(null, null, null, hstore('ref', searchhousenumber),
 279                     'place', 'house_number', null, null, true, true, 28, 0)::addressline;
 280     RETURN NEXT location;
 281   END IF;
 282
 283   IF search_unlisted_place is not null THEN
 284     RETURN NEXT ROW(null, null, null, hstore('name', search_unlisted_place),
 285                     'place', 'locality', null, null, true, true, 26, 0)::addressline;
 286   END IF;
 287
 288   IF searchpostcode IS NOT NULL THEN
 289     location := ROW(null, null, null, hstore('ref', searchpostcode), 'place',
 290                     'postcode', null, null, false, true, 5, 0)::addressline;
 291     RETURN NEXT location;
 292   END IF;
 293
 294   RETURN;
 295 END;
 296 $$
 297 LANGUAGE plpgsql STABLE;