Merge pull request #2032 from joto/additional-properties

Additional properties

Author: lonvia

docs/osm2pgsql-gen.md

@@ -36,13 +36,19 @@ mandatory for short options too.
     specified.
 
 -S, \--style=FILE
-:   The Lua config file. Same as for **osm2pgsql**.
+:   The Lua config file. Same as for **osm2pgsql**. Usually not required
+    because it is read from the `osm2pgsql_properties` table.
 
 -j, \-jobs=NUM
 :   Specifies the number of parallel threads used for certain operations.
     Setting this to the number of available CPU cores is a reasonable starting
     point.
 
+\--middle-schema=SCHEMA
+:   Database schema where the `osm2pgsql_properties` table is to be found.
+    Default `public`. Set to the same value as on the `osm2pgsql` command
+    line.
+
 # HELP/VERSION OPTIONS
 
 -h, \--help

src/command-line-parser.cpp

@@ -514,14 +514,6 @@ static void check_options(options_t *options)
         options->expire_tiles_zoom = 0;
     }
 
-    if (options->output_backend == "flex" ||
-        options->output_backend == "gazetteer") {
-        if (options->style == DEFAULT_STYLE) {
-            throw std::runtime_error{
-                "You have to set the config file with the -S|--style option."};
-        }
-    }
-
     if (options->output_backend == "gazetteer") {
         log_warn(
             "The 'gazetteer' output is deprecated and will soon be removed.");
@@ -623,6 +615,7 @@ options_t parse_command_line(int argc, char *argv[])
             break;
         case 'S': // --style
             options.style = optarg;
+            options.style_set = true;
             break;
         case 'i': // --tablespace-index
             options.tblsmain_index = optarg;
@@ -652,6 +645,7 @@ options_t parse_command_line(int argc, char *argv[])
             break;
         case 'O': // --output
             options.output_backend = optarg;
+            options.output_backend_set = true;
             break;
         case 'x': // --extra-attributes
             options.extra_attributes = true;

src/gen/osm2pgsql-gen.cpp

@@ -88,7 +88,7 @@ This program is EXPERIMENTAL and might change without notice.
 Main Options:
     -a|--append           Run in append mode
     -c|--create           Run in create mode (default)
-    -S|--style=FILE       The Lua config file (required, same as for osm2pgsql)
+    -S|--style=FILE       The Lua config file (same as for osm2pgsql)
     -j|--jobs=NUM         Number of parallel jobs (default 1)
        --middle-schema=SCHEMA  Database schema for middle tables
 
@@ -669,11 +669,6 @@ int main(int argc, char *argv[])
             return 2;
         }
 
-        if (style.empty()) {
-            log_error("Need --style/-S option");
-            return 2;
-        }
-
         if (jobs < 1 || jobs > 32) {
             log_error("The --jobs/-j parameter must be between 1 and 32.");
             return 2;
@@ -712,6 +707,14 @@ int main(int argc, char *argv[])
         properties_t properties{conninfo, schema};
         properties.load();
 
+        if (style.empty()) {
+            style = properties.get_string("style", "");
+            if (style.empty()) {
+                log_error("Need --style/-S option");
+                return 2;
+            }
+        }
+
         bool const updatable = properties.get_bool("updatable", false);
         genproc_t gen{style, conninfo, append, updatable, jobs};
         gen.run();

src/options.hpp

@@ -104,7 +104,7 @@ struct options_t
     /// Pg schema to store output tables in.
     std::string output_dbschema{"public"};
 
-    std::string style{DEFAULT_STYLE}; ///< style file to use
+    std::string style{}; ///< style file to use
 
     /// Name of the flat node file used. Empty if flat node file is not enabled.
     std::string flat_node_file{};
@@ -184,6 +184,9 @@ struct options_t
     bool parallel_indexing = true;
     bool create = false;
     bool pass_prompt = false;
+
+    bool output_backend_set = false;
+    bool style_set = false;
 }; // struct options_t
 
 #endif // OSM2PGSQL_OPTIONS_HPP

src/osm2pgsql.cpp

@@ -113,6 +113,16 @@ static void store_properties(properties_t *properties, options_t const &options)
     properties->set_bool("updatable", options.slim && !options.droptemp);
     properties->set_string("version", get_osm2pgsql_short_version());
     properties->set_int("db_format", options.middle_database_format);
+    properties->set_string("output", options.output_backend);
+
+    if (options.style.empty()) {
+        properties->set_string("style", "");
+    } else {
+        properties->set_string(
+            "style",
+            boost::filesystem::absolute(boost::filesystem::path{options.style})
+                .string());
+    }
 
     properties->store();
 }
@@ -241,6 +251,57 @@ static void check_db_format(properties_t const &properties, options_t *options)
     options->middle_database_format = format;
 }
 
+static void check_output(properties_t const &properties, options_t *options)
+{
+    auto const output = properties.get_string("output", "pgsql");
+
+    if (!options->output_backend_set) {
+        options->output_backend = output;
+        log_info("Using output '{}' (same as on import).", output);
+        return;
+    }
+
+    if (options->output_backend == output) {
+        return;
+    }
+
+    throw fmt_error("Different output specified on command line ('{}')"
+                    " then used on import ('{}').",
+                    options->output_backend, output);
+}
+
+static void check_and_update_style_file(properties_t *properties,
+                                        options_t *options)
+{
+    auto const style_file_from_import = properties->get_string("style", "");
+
+    if (options->style.empty()) {
+        log_info("Using style file '{}' (same as on import).",
+                 style_file_from_import);
+        options->style = style_file_from_import;
+        return;
+    }
+
+    if (style_file_from_import.empty()) {
+        throw std::runtime_error{"Style file from import is empty!?"};
+    }
+
+    const auto absolute_path =
+        boost::filesystem::absolute(boost::filesystem::path{options->style})
+            .string();
+
+    if (absolute_path == style_file_from_import) {
+        log_info("Using style file '{}' (same as on import).",
+                 style_file_from_import);
+        return;
+    }
+
+    log_info("Using the style file you specified on the command line"
+             " ('{}') instead of the one used on import ('{}').",
+             absolute_path, style_file_from_import);
+    properties->set_string("style", absolute_path, true);
+}
+
 // This is called in "append" mode to check that the command line options are
 // compatible with the properties stored in the database.
 static void check_and_update_properties(properties_t *properties,
@@ -251,6 +312,8 @@ static void check_and_update_properties(properties_t *properties,
     check_and_update_flat_node_file(properties, options);
     check_prefix(*properties, options);
     check_db_format(*properties, options);
+    check_output(*properties, options);
+    check_and_update_style_file(properties, options);
 }
 
 // If we are in append mode and the middle nodes table isn't there, it probably
@@ -270,6 +333,20 @@ static void check_for_nodes_table(options_t const &options)
     }
 }
 
+static void check_and_set_style(options_t *options)
+{
+    if (!options->style_set) {
+        if (options->output_backend == "flex" ||
+            options->output_backend == "gazetteer") {
+            throw std::runtime_error{"You have to set the config file "
+                                     "with the -S|--style option."};
+        }
+        if (options->output_backend == "pgsql") {
+            options->style = DEFAULT_STYLE;
+        }
+    }
+}
+
 int main(int argc, char *argv[])
 {
     try {
@@ -296,6 +373,7 @@ int main(int argc, char *argv[])
             if (properties.load()) {
                 check_and_update_properties(&properties, &options);
             } else {
+                check_and_set_style(&options);
                 check_for_nodes_table(options);
             }
 
@@ -313,6 +391,7 @@ int main(int argc, char *argv[])
                 }
             }
         } else {
+            check_and_set_style(&options);
             store_properties(&properties, options);
             auto const finfo = run(options);
             store_data_properties(&properties, finfo);

tests/bdd/regression/properties.feature

@@ -26,6 +26,21 @@ Feature: Updates to the test database with properties check
             | --slim       | --flat-nodes=x | Database was imported without flat node file   |
 
 
+    Scenario: Append without output on null output
+        When running osm2pgsql null with parameters
+            | -c     |
+            | --slim |
+
+        Given the input file '000466354.osc.gz'
+        When running osm2pgsql nooutput with parameters
+            | -a     |
+            | --slim |
+        Then the error output contains
+            """
+            Using output 'null' (same as on import).
+            """
+
+
     Scenario Outline: Create/append with various parameters
         When running osm2pgsql pgsql with parameters
             | --slim         |
@@ -50,3 +65,60 @@ Feature: Updates to the test database with properties check
             | --flat-nodes=x | --flat-nodes=y | Using the flat node file you specified        |
             | --prefix=abc   |                | Using prefix 'abc' (same as on import).       |
 
+
+    Scenario: Create with different output than append
+        When running osm2pgsql pgsql with parameters
+            | --slim |
+
+        Given the input file '000466354.osc.gz'
+        Then running osm2pgsql null with parameters fails
+            | -a     |
+            | --slim |
+        And the error output contains
+            """
+            Different output specified on command line
+            """
+
+    Scenario Outline: Create/append with with null output doesn't need style
+        When running osm2pgsql null with parameters
+            | --slim  |
+
+        Given the input file '000466354.osc.gz'
+        When running osm2pgsql null with parameters
+            | -a      |
+            | --slim  |
+            | <param> |
+        Then the error output contains
+            """
+            <message>
+            """
+
+        Examples:
+            | param    | message                                  |
+            |          | Using style file '' (same as on import). |
+            | --style= | Using style file '' (same as on import). |
+
+
+    @config.have_lua
+    Scenario Outline: Create/append with various style parameters with flex output
+        When running osm2pgsql flex with parameters
+            | --slim         |
+            | <param_create> |
+
+        Given the input file '000466354.osc.gz'
+        When running osm2pgsql flex with parameters
+            | -a             |
+            | --slim         |
+            | <param_append> |
+        Then the error output contains
+            """
+            <message>
+            """
+
+        Examples:
+            | param_create                                 | param_append                                      | message                            |
+            | --style={TEST_DATA_DIR}/test_output_flex.lua |                                                   | Using style file                   |
+            | --style={TEST_DATA_DIR}/test_output_flex.lua | --style={TEST_DATA_DIR}/test_output_flex.lua      | Using style file                   |
+            | --style={TEST_DATA_DIR}/test_output_flex.lua | --style={TEST_DATA_DIR}/test_output_flex_copy.lua | Using the style file you specified |
+
+