]> git.openstreetmap.org Git - nominatim.git/commitdiff
Merge pull request #3045 from biswajit-k/taginfo
authorSarah Hoffmann <lonvia@denofr.de>
Wed, 21 Jun 2023 08:01:40 +0000 (10:01 +0200)
committerGitHub <noreply@github.com>
Wed, 21 Jun 2023 08:01:40 +0000 (10:01 +0200)
Add script to generate taginfo project description

.github/actions/build-nominatim/action.yml
.github/workflows/ci-tests.yml
settings/flex-base.lua
settings/import-extratags.lua
settings/import-full.lua
settings/taginfo.lua [new file with mode: 0644]
vagrant/Install-on-Ubuntu-20.sh
vagrant/Install-on-Ubuntu-22.sh

index 5d06267c0453808ec1a66ae3ac66c5af27150276..eaab5ae01765fc8188cd5a8da0f2f8a0b16e8412 100644 (file)
@@ -25,7 +25,7 @@ runs:
           shell: bash
         - name: Install${{ matrix.flavour }} prerequisites
           run: |
-            sudo apt-get install -y -qq libboost-system-dev libboost-filesystem-dev libexpat1-dev zlib1g-dev libbz2-dev libpq-dev libproj-dev libicu-dev liblua${LUA_VERSION}-dev lua${LUA_VERSION}
+            sudo apt-get install -y -qq libboost-system-dev libboost-filesystem-dev libexpat1-dev zlib1g-dev libbz2-dev libpq-dev libproj-dev libicu-dev liblua${LUA_VERSION}-dev lua${LUA_VERSION} lua-dkjson
             if [ "$FLAVOUR" == "oldstuff" ]; then
                 pip3 install MarkupSafe==2.0.1 python-dotenv psycopg2==2.7.7 jinja2==2.8 psutil==5.4.2 pyicu==2.9 osmium PyYAML==5.1 sqlalchemy==1.4 GeoAlchemy2==0.10.0 datrie asyncpg
             else
index 7dfb3f1d34b0b677940abf7695986fcd87070001..44141e6c7bb6a88ad5c9e25583e32e1b6682997a 100644 (file)
@@ -250,6 +250,9 @@ jobs:
             - name: Prepare import environment
               run: |
                   mv Nominatim/test/testdb/apidb-test-data.pbf test.pbf
+                  mv Nominatim/settings/flex-base.lua flex-base.lua
+                  mv Nominatim/settings/import-extratags.lua import-extratags.lua
+                  mv Nominatim/settings/taginfo.lua taginfo.lua
                   rm -rf Nominatim
                   mkdir data-env-reverse
               working-directory: /home/nominatim
@@ -258,6 +261,10 @@ jobs:
               run: nominatim --version
               working-directory: /home/nominatim/nominatim-project
 
+            - name: Print taginfo
+              run: lua taginfo.lua
+              working-directory: /home/nominatim
+
             - name: Collect host OS information
               run: nominatim admin --collect-os-info
               working-directory: /home/nominatim/nominatim-project
index 58d6022802db1bbd4bf1b2191348fa62685ebd35..fbfb4d54620decaf791550ebc76e0302c2792896 100644 (file)
@@ -11,6 +11,11 @@ local ADDRESS_TAGS = nil
 local SAVE_EXTRA_MAINS = false
 local POSTCODE_FALLBACK = true
 
+-- tables required for taginfo
+module.TAGINFO_MAIN = {keys = {}, delete_tags = {}}
+module.TAGINFO_NAME_KEYS = {}
+module.TAGINFO_ADDRESS_KEYS = {}
+
 
 -- The single place table.
 local place_table = osm2pgsql.define_table{
@@ -372,6 +377,17 @@ function module.tag_group(data)
     end
 end
 
+-- Returns prefix part of the keys, and reject suffix matching keys
+local function process_key(key)
+    if key:sub(1, 1) == '*' then
+        return nil
+    end
+    if key:sub(#key, #key) == '*' then
+        return key:sub(1, #key - 2)
+    end
+    return key
+end
+
 -- Process functions for all data types
 function module.process_node(object)
 
@@ -465,14 +481,29 @@ function module.set_prefilters(data)
     PRE_DELETE = module.tag_match{keys = data.delete_keys, tags = data.delete_tags}
     PRE_EXTRAS = module.tag_match{keys = data.extra_keys,
                                   tags = data.extra_tags}
+    module.TAGINFO_MAIN.delete_tags = data.delete_tags
 end
 
 function module.set_main_tags(data)
     MAIN_KEYS = data
+    local keys = {}
+    for k, _ in pairs(data) do
+        table.insert(keys, k)
+    end
+    module.TAGINFO_MAIN.keys = keys
 end
 
 function module.set_name_tags(data)
     NAMES = module.tag_group(data)
+
+    for _, lst in pairs(data) do
+        for _, k in ipairs(lst) do
+            local key = process_key(k)
+            if key ~= nil then
+                module.TAGINFO_NAME_KEYS[key] = true
+            end
+        end
+    end
 end
 
 function module.set_address_tags(data)
@@ -480,8 +511,18 @@ function module.set_address_tags(data)
         POSTCODE_FALLBACK = data.postcode_fallback
         data.postcode_fallback = nil
     end
-
     ADDRESS_TAGS = module.tag_group(data)
+
+    for _, lst in pairs(data) do
+        if lst ~= nil then
+            for _, k in ipairs(lst) do
+                local key = process_key(k)
+                if key ~= nil then
+                    module.TAGINFO_ADDRESS_KEYS[key] = true
+                end
+            end
+        end
+    end
 end
 
 function module.set_unused_handling(data)
index fd9a15f3ba34629ca890e0452812df7d0faa8c2b..204bd1c8f56be7632195b92179ad408b4881ddef 100644 (file)
@@ -7,7 +7,6 @@ flex.set_main_tags{
     historic = 'always',
     military = 'always',
     natural = 'named',
-    landuse = 'named',
     highway = {'always',
                street_lamp = 'named',
                traffic_signals = 'named',
index 1b64124dfcb4aa85411a35a6e293f4b166f3771a..1dc317a9bc0f5e1b4c9bcbd3d1ee4e1a6996f449 100644 (file)
@@ -7,7 +7,6 @@ flex.set_main_tags{
     historic = 'always',
     military = 'always',
     natural = 'named',
-    landuse = 'named',
     highway = {'always',
                street_lamp = 'named',
                traffic_signals = 'named',
diff --git a/settings/taginfo.lua b/settings/taginfo.lua
new file mode 100644 (file)
index 0000000..0eaa96e
--- /dev/null
@@ -0,0 +1,74 @@
+-- Prints taginfo project description in the standard output
+--
+
+-- create fake "osm2pgsql" table for flex-base, originally created by the main C++ program
+osm2pgsql = {}
+function osm2pgsql.define_table(...) end
+
+-- provide path to flex-style lua file
+flex = require('import-extratags')
+local json = require ('dkjson')
+
+
+------------ helper functions ---------------------
+
+function get_key_description(key, description)
+    local desc = {}
+    desc.key = key
+    desc.description = description
+    set_keyorder(desc, {'key', 'description'})
+    return desc
+end
+
+-- Sets the key order for the resulting JSON table
+function set_keyorder(table, order)
+    setmetatable(table, {
+        __jsonorder = order
+    })
+end
+
+
+-- Prints the collected tags in the required format in JSON
+function print_taginfo()
+    local tags = {}
+
+    for _, k in ipairs(flex.TAGINFO_MAIN.keys) do
+        local desc = get_key_description(k, 'POI/feature in the search database')
+        if flex.TAGINFO_MAIN.delete_tags[k] ~= nil then
+            desc.description = string.format('%s(except for values: %s).', desc.description,
+                                table.concat(flex.TAGINFO_MAIN.delete_tags[k], ', '))
+        end
+        table.insert(tags, desc)
+    end
+
+    for k, _ in pairs(flex.TAGINFO_NAME_KEYS) do
+        local desc = get_key_description(k, 'Searchable name of the place.')
+        table.insert(tags, desc)
+    end
+    for k, _ in pairs(flex.TAGINFO_ADDRESS_KEYS) do
+        local desc = get_key_description(k, 'Used to determine the address of a place.')
+        table.insert(tags, desc)
+    end
+
+    local format = {
+        data_format = 1,
+        data_url = 'http://nominatim.openstreetmap.org/taginfo.json',
+        project = {
+            name = 'Nominatim',
+            description = 'OSM search engine.',
+            project_url = 'http://nominatim.openstreetmap.org',
+            doc_url = 'http://wiki.osm.org/wiki/Nominatim',
+            contact_name = 'Sarah Hoffmann',
+            contact_email = 'lonvia@denofr.de'
+        }
+    }
+    format.tags = tags
+
+    set_keyorder(format, {'data_format', 'data_url', 'project', 'tags'})
+    set_keyorder(format.project, {'name', 'description', 'project_url', 'doc_url',
+                    'contact_name', 'contact_email'})
+
+    print(json.encode(format))
+end
+
+print_taginfo()
index 529670925b2333cd5defd16869f3fa321cdd109d..ef77657983c326f1436ecb32ac397042d8a8f855 100755 (executable)
@@ -23,7 +23,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
     sudo apt install -y php-cgi
     sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
                         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
-                        libbz2-dev libpq-dev liblua5.3-dev lua5.3 \
+                        libbz2-dev libpq-dev liblua5.3-dev lua5.3 lua-dkjson \
                         postgresql-12-postgis-3 \
                         postgresql-contrib-12 postgresql-12-postgis-3-scripts \
                         php-cli php-pgsql php-intl libicu-dev python3-dotenv \
index 7a4d146fd71d32f9b345a139c8566e20fe30e94b..c44cf87d518f4e273b9323d74a9c78a3c825024b 100755 (executable)
@@ -23,7 +23,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
     sudo apt install -y php-cgi
     sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
                         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
-                        libbz2-dev libpq-dev liblua5.3-dev lua5.3 \
+                        libbz2-dev libpq-dev liblua5.3-dev lua5.3 lua-dkjson \
                         postgresql-server-dev-14 postgresql-14-postgis-3 \
                         postgresql-contrib-14 postgresql-14-postgis-3-scripts \
                         php-cli php-pgsql php-intl libicu-dev python3-dotenv \