openstreetmap-carto.lua

-- For documentation of Lua tag transformations, see:
-- https://osm2pgsql.org/doc/manual.html#the-flex-output

local tables = {}

-- A list of text columns per table, replacing the legacy osm2pgsql 'pgsql output' .style file.
-- These are inserted into the table list of columns in the same order as lists here,
-- and thus determine column order in the final tables.
-- Non-text columns are defined in col_definitions.
local pg_cols = {
    point = {
        'access',
        'addr:housename',
        'addr:housenumber',
        'admin_level',
        'aerialway',
        'aeroway',
        'amenity',
        'barrier',
        'boundary',
        'building',
        'highway',
        'historic',
        'junction',
        'landuse',
        'leisure',
        'lock',
        'man_made',
        'military',
        'name',
        'natural',
        'oneway',
        'place',
        'power',
        'railway',
        'ref',
        'religion',
        'shop',
        'tourism',
        'water',
        'waterway'
    },
    line = {
        'access',
        'addr:housename',
        'addr:housenumber',
        'addr:interpolation',
        'admin_level',
        'aerialway',
        'aeroway',
        'amenity',
        'barrier',
        'bicycle',
        'bridge',
        'boundary',
        'building',
        'construction',
        'covered',
        'foot',
        'highway',
        'historic',
        'horse',
        'junction',
        'landuse',
        'leisure',
        'lock',
        'man_made',
        'military',
        'name',
        'natural',
        'oneway',
        'place',
        'power',
        'railway',
        'ref',
        'religion',
        'route',
        'service',
        'shop',
        'surface',
        'tourism',
        'tracktype',
        'tunnel',
        'water',
        'waterway'
    },
    transport_line = {
        'access',
        'aeroway',
        'bicycle',
        'bridge',
        'construction',
        'covered',
        'foot',
        'highway',
        'horse',
        'name',
        'oneway',
        'railway',
        'ref',
        'service',
        'surface',
        'tracktype',
        'tunnel'
    },
    transport_polygon = {
        'access',
        'bicycle',
        'bridge',
        'construction',
        'covered',
        'foot',
        'highway',
        'horse',
        'name',
        'oneway',
        'railway',
        'ref',
        'service',
        'surface',
        'tracktype',
        'tunnel'
    },
    route = {
        'route',
        'ref',
        'network'
    },
    admin = {}
}

-- The roads and polygon columns are the same as the line columns
pg_cols.roads = pg_cols.line
pg_cols.polygon = pg_cols.line

-- These columns aren't text columns
col_definitions = {
    point = {
        { column = 'way', type = 'point' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' }
    },
    line = {
        { column = 'way', type = 'linestring' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' },
        { column = 'z_order', type = 'int4' }
    },
    transport_line = {
        { column = 'way', type = 'linestring' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' },
        { column = 'z_order', type = 'int4' }
    },
    transport_polygon = {
        { column = 'way', type = 'geometry' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' },
        { column = 'z_order', type = 'int4' },
        { column = 'way_area', type = 'area' }
    },
    roads = {
        { column = 'way', type = 'linestring' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' },
        { column = 'z_order', type = 'int4' }
    },
    polygon = {
        { column = 'way', type = 'geometry' },
        { column = 'tags', type = 'hstore' },
        { column = 'layer', type = 'int4' },
        { column = 'z_order', type = 'int4' },
        { column = 'way_area', type = 'area' }    
    },
    route = {
        { column = 'member_id', type = 'int8' },
        { column = 'member_position', type = 'int4' },
        { column = 'tags', type = 'hstore' }
    },
    admin = {
        { column = 'way', type = 'linestring' },
        { column = 'admin_level', type = 'int2' },
        { column = 'multiple_relations', type = 'boolean' }
    }
}

-- Combine the two sets of columns and create a map with column names.
-- The latter is needed for quick lookup to see if a tag has a column.
local columns_map = {}
for tablename, columns in pairs(pg_cols) do
    columns_map[tablename] = {}
    for _, key in ipairs(columns) do
        table.insert(col_definitions[tablename], {column = key, type = "text"})
        columns_map[tablename][key] = true
    end
end

tables.point = osm2pgsql.define_table{
    name = 'planet_osm_point',
    ids = { type = 'node', id_column = 'osm_id' },
    columns = col_definitions.point
}

tables.line = osm2pgsql.define_table{
    name = 'planet_osm_line',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.line
}

tables.transport_line = osm2pgsql.define_table{
    name = 'planet_osm_transport_line',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.transport_line
}

tables.roads = osm2pgsql.define_table{
    name = 'planet_osm_roads',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.roads
}

tables.polygon = osm2pgsql.define_table{
    name = 'planet_osm_polygon',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.polygon
}

tables.transport_polygon = osm2pgsql.define_table{
    name = 'planet_osm_transport_polygon',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.transport_polygon
}

tables.route = osm2pgsql.define_table{
    name = 'planet_osm_route',
    ids = { type = 'relation', id_column = 'osm_id' },
    columns = col_definitions.route
}

tables.admin = osm2pgsql.define_table{
    name = 'planet_osm_admin',
    ids = { type = 'way', id_column = 'osm_id' },
    columns = col_definitions.admin
}

-- Objects with any of the following keys will be treated as polygon
local polygon_keys = {
    'abandoned:aeroway',
    'abandoned:amenity',
    'abandoned:building',
    'abandoned:landuse',
    'abandoned:power',
    'aeroway',
    'allotments',
    'amenity',
    'area:highway',
    'craft',
    'building',
    'building:part',
    'club',
    'golf',
    'emergency',
    'harbour',
    'healthcare',
    'historic',
    'landuse',
    'leisure',
    'man_made',
    'military',
    'natural',
    'office',
    'place',
    'power',
    'public_transport',
    'shop',
    'tourism',
    'water',
    'wetland'
}

-- Objects with any of the following key/value combinations will be treated as linestring
local linestring_values = {
    golf = {cartpath = true, hole = true, path = true}, 
    emergency = {designated = true, destination = true, no = true, official = true, yes = true},
    historic = {citywalls = true},
    leisure = {track = true, slipway = true},
    man_made = {breakwater = true, cutline = true, embankment = true, groyne = true, pipeline = true},
    natural = {cliff = true, earth_bank = true, tree_row = true, ridge = true, arete = true},
    power = {cable = true, line = true, minor_line = true},
    tourism = {yes = true}
}

-- Objects with any of the following key/value combinations will be treated as polygon
local polygon_values = {
    aerialway = {station = true},
    boundary = {aboriginal_lands = true, national_park = true, protected_area= true},
    highway = {services = true, rest_area = true},
    junction = {yes = true},
    railway = {station = true},
    waterway = {dock = true, boatyard = true, fuel = true, riverbank = true}
}

-- The following keys will be deleted
local delete_tags = {
    'note',
    'source',
    'source_ref',
    'attribution',
    'comment',
    'fixme',
    -- Tags generally dropped by editors, not otherwise covered
    'created_by',
    'odbl',
    -- Lots of import tags
    -- EUROSHA (Various countries)
    'project:eurosha_2012',

    -- UrbIS (Brussels, BE)
    'ref:UrbIS',

    -- NHN (CA)
    'accuracy:meters',
    'waterway:type',
    -- StatsCan (CA)
    'statscan:rbuid',

    -- RUIAN (CZ)
    'ref:ruian:addr',
    'ref:ruian',
    'building:ruian:type',
    -- DIBAVOD (CZ)
    'dibavod:id',
    -- UIR-ADR (CZ)
    'uir_adr:ADRESA_KOD',

    -- GST (DK)
    'gst:feat_id',
    -- osak (DK)
    'osak:identifier',

    -- Maa-amet (EE)
    'maaamet:ETAK',
    -- FANTOIR (FR)
    'ref:FR:FANTOIR',

    -- OPPDATERIN (NO)
    'OPPDATERIN',
    -- Various imports (PL)
    'addr:city:simc',
    'addr:street:sym_ul',
    'building:usage:pl',
    'building:use:pl',
    -- TERYT (PL)
    'teryt:simc',

    -- RABA (SK)
    'raba:id',

    -- LINZ (NZ)
    'linz2osm:objectid',
    -- DCGIS (Washington DC, US)
    'dcgis:gis_id',
    -- Building Identification Number (New York, US)
    'nycdoitt:bin',
    -- Chicago Building Import (US)
    'chicago:building_id',
    -- Louisville, Kentucky/Building Outlines Import (US)
    'lojic:bgnum',
    -- MassGIS (Massachusetts, US)
    'massgis:way_id',

    -- misc
    'import',
    'import_uuid',
    'OBJTYPE',
    'SK53_bulk:load'
}
delete_prefixes = {
    'note:',
    'source:',
    -- Corine (CLC) (Europe)
    'CLC:',

    -- Geobase (CA)
    'geobase:',
    -- CanVec (CA)
    'canvec:',
    -- Geobase (CA)
    'geobase:',

    -- kms (DK)
    'kms:',

    -- ngbe (ES)
    -- See also note:es and source:file above
    'ngbe:',

    -- Friuli Venezia Giulia (IT)
    'it:fvg:',

    -- KSJ2 (JA)
    -- See also note:ja and source_ref above
    'KSJ2:',
    -- Yahoo/ALPS (JA)
    'yh:',

    -- LINZ (NZ)
    'LINZ2OSM:',
    'LINZ:',

    -- WroclawGIS (PL)
    'WroclawGIS:',
    -- Naptan (UK)
    'naptan:',

    -- TIGER (US)
    'tiger:',
    -- GNIS (US)
    'gnis:',
    -- National Hydrography Dataset (US)
    'NHD:',
    'nhd:',
    -- mvdgis (Montevideo, UY)
    'mvdgis:'
}

-- Big table for z_order and roads status for certain tags. 
-- The road status (true/false) determines whether or not the feature will be
-- included in the legacy 'roads' table.
-- z=0 is turned into nil by the z_order function.
-- Road z values are divided by 10 for objects tagged as highway=construction,
-- construction=[HIGHWAY_CLASS], so must be multiples of 10.
local roads_info = {
    highway = {
        motorway        = {z = 380, roads = true},
        trunk           = {z = 370, roads = true},
        primary         = {z = 360, roads = true},
        secondary       = {z = 350, roads = true},
        tertiary        = {z = 340, roads = false},
        residential     = {z = 330, roads = false},
        unclassified    = {z = 330, roads = false},
        road            = {z = 330, roads = false},
        living_street   = {z = 320, roads = false},
        pedestrian      = {z = 310, roads = false},
        raceway         = {z = 300, roads = false},
        motorway_link   = {z = 240, roads = true},
        trunk_link      = {z = 230, roads = true},
        primary_link    = {z = 220, roads = true},
        secondary_link  = {z = 210, roads = true},
        tertiary_link   = {z = 200, roads = false},
        busway          = {z = 170, roads = false},
        service         = {z = 150, roads = false},
        track           = {z = 110, roads = false},
        path            = {z = 100, roads = false},
        footway         = {z = 100, roads = false},
        bridleway       = {z = 100, roads = false},
        cycleway        = {z = 100, roads = false},
        steps           = {z = 90,  roads = false},
        platform        = {z = 90,  roads = false}
    },
    railway = {
        rail            = {z = 440, roads = true},
        subway          = {z = 420, roads = true},
        narrow_gauge    = {z = 420, roads = true},
        light_rail      = {z = 420, roads = true},
        funicular       = {z = 420, roads = true},
        preserved       = {z = 420, roads = false},
        monorail        = {z = 420, roads = false},
        miniature       = {z = 420, roads = false},
        turntable       = {z = 420, roads = false},
        tram            = {z = 410, roads = false},
        disused         = {z = 400, roads = false},
        construction    = {z = 400, roads = false},
        platform        = {z = 90,  roads = false},
    },
    aeroway = {
        runway          = {z = 60,  roads = false},
        taxiway         = {z = 50,  roads = false},
    },
    boundary = {
        administrative  = {z = 0,  roads = true}
    },
}

local excluded_railway_service = {
    spur = true,
    siding = true,
    yard = true
}
--- Gets the z_order for a set of tags
-- @param tags OSM tags
-- @return z_order if an object with z_order, otherwise nil
function z_order(tags)
    local z = 0
    for k, v in pairs(tags) do
        if roads_info[k] and roads_info[k][v] then
            z = math.max(z, roads_info[k][v].z)
        end
    end

    if tags["highway"] == "construction" then
        if tags["construction"] and roads_info["highway"][tags["construction"]] then
            z = math.max(z, roads_info["highway"][tags["construction"]].z/10)
        else
            -- For unknown roads, assume highway=road
            z = math.max(z, roads_info["highway"]["road"].z/10)
        end
    end

    return z ~= 0 and z or nil
end

--- Gets the roads table status for a set of tags
-- @param tags OSM tags
-- @return true if it belongs in the roads table, false otherwise
function roads(tags)
    for k, v in pairs(tags) do
        if roads_info[k] and roads_info[k][v] and roads_info[k][v].roads then
            if not (k ~= 'railway' or tags.service) then
                return true
            elseif not excluded_railway_service[tags.service] then
                return true
            end
        end
    end
    return false
end

--- Check if an object with given tags should be treated as polygon
-- @param tags OSM tags
-- @return true if area, false if linear
function isarea (tags)
    -- Treat objects tagged as area=yes polygon, other area as no
    if tags["area"] then
        return tags["area"] == "yes" and true or false
    end

   -- Search through object's tags
    for k, v in pairs(tags) do
        -- Check if it has a polygon key and not a linestring override, or a polygon k=v
        for _, ptag in ipairs(polygon_keys) do
            if k == ptag and v ~= "no" and not (linestring_values[k] and linestring_values[k][v]) then
                return true
            end
        end

        if (polygon_values[k] and polygon_values[k][v]) then
            return true
        end
    end
    return false
end

--- Normalizes layer tags to integers
-- @param v The layer tag value
-- @return The input value if it is an integer between -100 and 100, or nil otherwise
function layer (v)
    return v and -- Check that layer is non-nil
        string.find(v, "^-?%d+$") and tonumber(v) < 100 and tonumber(v) > -100 and v or nil -- Enforce numeric limits and return v, or nil if fails to meet limits
end

--- Normalizes admin_level tags
-- @param v The admin_level tag value
-- @return The input value if it is an integer between 0 and 100, or nil otherwise
function admin_level (v)
    return v and -- Check that admin_level is non-nil
        string.find(v, "^%d+$") and tonumber(v) < 100 and tonumber(v) > 0 and v or nil -- Enforce numeric limits and return v, or nil if fails to meet limits
end

--- Clean tags of deleted tags
-- @param tags OSM tags
-- @return true if no tags are left after cleaning
function clean_tags(tags)
    -- Short-circuit for untagged objects
    if next(tags) == nil then
        return true
    end

    -- Delete tags listed in delete_tags
    for _, d in ipairs(delete_tags) do
        tags[d] = nil
    end
    -- By using a second loop for wildcards we avoid checking already deleted tags
    for tag, _ in pairs (tags) do
        for _, d in ipairs(delete_prefixes) do
            if string.sub(tag, 1, string.len(d)) == d then
                tags[tag] = nil
                break
            end
        end
    end

    return next(tags) == nil
end

--- Splits a tag into tags and hstore tags
-- @param tags OSM tags
-- @param tag_map Lua table that contains the OSM tags that will get a dedicated column
-- @return columns, hstore tags
function split_tags(tags, tag_map)
    local cols = {tags = {}}

    for key, value in pairs(tags) do
        if tag_map[key] then
            cols[key] = value
        else
            cols.tags[key] = value
        end
    end

    -- layer is a special tag. After setting the columns, we have to go back and set it after making sure it's an integer, and remove it from tags
    cols['layer'] = layer(tags['layer'])
    cols.tags['layer'] = nil

    return cols
end

phase2_admin_ways_level = {}
phase2_admin_ways_parents = {}

-- Processing callbacks (https://osm2pgsql.org/doc/manual.html#processing-callbacks) and functions that directly support them

--- Add an object to the point table
-- @param object parameter table supplied by osm2pgsql
function add_point(object)
    local cols = split_tags(object.tags, columns_map.point)
    tables.point:add_row(cols)
end

--- Add an object to the line table
-- @param object parameter table supplied by osm2pgsql
function add_line(object)
    local cols = split_tags(object.tags, columns_map.line)
    cols['z_order'] = z_order(object.tags)
    cols.way = { create = 'line', split_at = 100000 }
    tables.line:add_row(cols)
end

--- Add an object to the transport_line table
-- @param object parameter table supplied by osm2pgsql
function add_transport_line(object)
    local cols = split_tags(object.tags, columns_map.transport_line)
    cols['z_order'] = z_order(object.tags)
    cols.way = { create = 'line', split_at = 100000 }
    tables.transport_line:add_row(cols)
end

--- Add an object to the roads table
-- @param object parameter table supplied by osm2pgsql
function add_roads(object)
    local cols = split_tags(object.tags, columns_map.roads)
    cols['z_order'] = z_order(object.tags)
    cols.way = { create = 'line', split_at = 100000 }
    tables.roads:add_row(cols)
end

--- Add an object to the polygon table
-- @param object parameter table supplied by osm2pgsql
function add_polygon(object)
    local cols = split_tags(object.tags, columns_map.polygon)
    cols['z_order'] = z_order(object.tags)
    cols.way = { create = 'area', split_at = nil }
    tables.polygon:add_row(cols)
end

--- Add an object to the transport_polygon table
-- @param object parameter table supplied by osm2pgsql
function add_transport_polygon(object)
    local cols = split_tags(object.tags, columns_map.transport_polygon)
    cols['z_order'] = z_order(object.tags)
    cols.way = { create = 'area', split_at = nil }
    tables.transport_polygon:add_row(cols)
end

--- Add an object to the route table
-- @param object parameter table supplied by osm2pgsql
function add_route(object)
    for i, member in ipairs(object.members) do
        if member.type == 'w' then
            local cols = split_tags(object.tags, columns_map.route)
            cols.member_id = member.ref
            cols.member_position = i
            tables.route:add_row(cols)
        end
    end
end

function osm2pgsql.process_node(object)
    if clean_tags(object.tags) then
        return
    end

    add_point(object)
end

function osm2pgsql.process_way(object)
    if osm2pgsql.stage == 2 then
        -- Stage two processing is called on ways that are part of admin boundary relations
        if phase2_admin_ways_level[object.id] then
            tables.admin:add_row({admin_level = phase2_admin_ways_level[object.id],
                                  multiple_relations = (phase2_admin_ways_parents[object.id] > 1),
                                  way = { create = 'line' }})
        end
    end
    if clean_tags(object.tags) then
        return
    end

    local area_tags = isarea(object.tags)
    if object.is_closed and area_tags then
        add_polygon(object)

        if z_order(object.tags) ~= nil then
            add_transport_polygon(object)
        end
    else
        add_line(object)

        if z_order(object.tags) ~= nil then
            add_transport_line(object)
        end

        if roads(object.tags) then
            add_roads(object)
        end
    end
end

function osm2pgsql.process_relation(object)
    -- grab the type tag before filtering tags
    local type = object.tags.type
    object.tags.type = nil

    if clean_tags(object.tags) then
        return
    end
    if type == "boundary" then
        add_line(object)

        if roads(object.tags) then
            add_roads(object)
        end

        add_polygon(object)

    elseif type == "multipolygon" then
        add_polygon(object)

        if z_order(object.tags) ~= nil then
            add_transport_polygon(object)
        end
    elseif type == "route" then
        add_route(object)
    end
end

function osm2pgsql.select_relation_members(relation)
    if relation.tags.type == 'boundary'
       and relation.tags.boundary == 'administrative' then
        local admin = tonumber(admin_level(relation.tags.admin_level))
        if admin ~= nil then
            for _, ref in ipairs(osm2pgsql.way_member_ids(relation)) do
                -- Store the lowest admin_level, and how many relations it used in
                if not phase2_admin_ways_level[ref] then
                    phase2_admin_ways_level[ref] = admin
                    phase2_admin_ways_parents[ref] = 1
                else
                    if phase2_admin_ways_level[ref] == admin then
                        phase2_admin_ways_parents[ref] = phase2_admin_ways_parents[ref] + 1
                    elseif admin < phase2_admin_ways_level[ref] then
                        phase2_admin_ways_level[ref] = admin
                        phase2_admin_ways_parents[ref] = 1
                    end
                end
            end
            return { ways = osm2pgsql.way_member_ids(relation) }
        end
    end
end