docs: improve contents listing

[nominatim.git] / CMakeLists.txt

diff --git a/CMakeLists.txt b/CMakeLists.txt
index b7a2caaf72d3889e2a013f53e8152a01fdd52b0e..d1c2702a06954154ef4c4c3469a24766cead1f46 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -6,7 +6,7 @@
 #
 #-----------------------------------------------------------------------------
 
 #
 #-----------------------------------------------------------------------------
 

-cmake_minimum_required(VERSION 2.8 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.0 FATAL_ERROR)

 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 


@@ -18,158 +18,260 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 project(nominatim)
 
 
 project(nominatim)
 

-set(NOMINATIM_VERSION_MAJOR 3)
-set(NOMINATIM_VERSION_MINOR 2)
+set(NOMINATIM_VERSION_MAJOR 4)
+set(NOMINATIM_VERSION_MINOR 4)

 set(NOMINATIM_VERSION_PATCH 0)
 
 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
 
 add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
 
 set(NOMINATIM_VERSION_PATCH 0)
 
 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
 
 add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
 

+# Setting GIT_HASH
+find_package(Git)
+if (GIT_FOUND)
+    execute_process(
+        COMMAND "${GIT_EXECUTABLE}" log -1 --format=%h
+        WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
+        OUTPUT_VARIABLE GIT_HASH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        ERROR_QUIET
+        )
+endif()

 
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------

-#
-#  Find external dependencies
-#
+#  Configuration

 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 

-set(BUILD_TESTS off CACHE BOOL "Build test suite" FORCE)
-set(WITH_LUA off CACHE BOOL "Build with lua support" FORCE)
+set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
+set(BUILD_API on CACHE BOOL "Build everything for the API server")
+set(BUILD_MODULE off CACHE BOOL "Build PostgreSQL module for legacy tokenizer")
+set(BUILD_TESTS on CACHE BOOL "Build test suite")
+set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
+set(INSTALL_MUNIN_PLUGINS on CACHE BOOL "Install Munin plugins for supervising Nominatim")
+
+#-----------------------------------------------------------------------------
+#  osm2pgsql (imports/updates only)
+#-----------------------------------------------------------------------------

 
 

-if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
-    message(FATAL_ERROR "The osm2pgsql directory is empty.\
-    Did you forget to check out Nominatim recursively?\
-    \nTry updating submodules with: git submodule update --init")
+if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
+    if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
+        message(FATAL_ERROR "The osm2pgsql directory is empty.\
+        Did you forget to check out Nominatim recursively?\
+        \nTry updating submodules with: git submodule update --init")
+    endif()
+    set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
+    set(BUILD_TESTS off)
+    add_subdirectory(osm2pgsql)
+    set(BUILD_TESTS ${BUILD_TESTS_SAVED})

 endif()
 endif()

-add_subdirectory(osm2pgsql)
-
-find_package(Threads REQUIRED)
-
-unset(PostgreSQL_TYPE_INCLUDE_DIR CACHE)
-set(PostgreSQL_TYPE_INCLUDE_DIR "/usr/include/")
-find_package(PostgreSQL REQUIRED)
-include_directories(${PostgreSQL_INCLUDE_DIRS})
-link_directories(${PostgreSQL_LIBRARY_DIRS})
-
-find_program(PYOSMIUM pyosmium-get-changes)
-if (NOT EXISTS "${PYOSMIUM}")
-    set(PYOSMIUM_PATH "")
-        message(WARNING "pyosmium-get-changes not found (required for updates)")
-else()
-    set(PYOSMIUM_PATH "${PYOSMIUM}")
-    message(STATUS "Using pyosmium-get-changes at ${PYOSMIUM_PATH}")
+
+
+#-----------------------------------------------------------------------------
+#  python (imports/updates only)
+#-----------------------------------------------------------------------------
+
+if (BUILD_IMPORTER OR BUILD_API)
+    find_package(PythonInterp 3.7 REQUIRED)

 endif()
 
 endif()
 

+#-----------------------------------------------------------------------------
+# PHP
+#-----------------------------------------------------------------------------

 
 

-find_program(PG_CONFIG pg_config)
-execute_process(COMMAND ${PG_CONFIG} --pgxs
-                OUTPUT_VARIABLE PGXS
-                OUTPUT_STRIP_TRAILING_WHITESPACE)
+# Setting PHP binary variable as to command line (prevailing) or auto detect

 
 

-if (NOT EXISTS "${PGXS}")
-    message(FATAL_ERROR "Postgresql server package not found.")
+if (BUILD_API)
+    if (NOT PHP_BIN)
+         find_program (PHP_BIN php)
+    endif()
+    # sanity check if PHP binary exists
+    if (NOT EXISTS ${PHP_BIN})
+        message(WARNING "PHP binary not found. Only Python frontend can be used.")
+        set(PHP_BIN "")
+    else()
+        message (STATUS "Using PHP binary " ${PHP_BIN})
+    endif()

 endif()
 
 endif()
 

-find_package(ZLIB REQUIRED)
+#-----------------------------------------------------------------------------
+# import scripts and utilities (importer only)
+#-----------------------------------------------------------------------------

 
 

-find_package(BZip2 REQUIRED)
+if (BUILD_IMPORTER)
+   find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz
+             PATHS ${PROJECT_SOURCE_DIR}/data
+             NO_DEFAULT_PATH
+             DOC "Location of the country grid file."
+            )

 
 

-find_package(LibXml2 REQUIRED)
-include_directories(${LIBXML2_INCLUDE_DIR})
+   if (NOT COUNTRY_GRID_FILE)
+       message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n"
+                           "    wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz")
+   endif()

 
 

-# Setting PHP binary variable as to command line (prevailing) or auto detect
-if (NOT PHP_BIN)
-     find_program (PHP_BIN php)
-endif()
-# sanity check if PHP binary exists
-if (NOT EXISTS ${PHP_BIN})
-    message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
+   configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
+                  ${PROJECT_BINARY_DIR}/nominatim)

 endif()
 endif()

-message (STATUS "Using PHP binary " ${PHP_BIN})

 
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------

-#
-# Setup settings and paths
-#
+# Tests

 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 

-set(WEBSITESCRIPTS
-    website/deletable.php
-    website/details.php
-    website/hierarchy.php
-    website/lookup.php
-    website/polygons.php
-    website/reverse.php
-    website/search.php
-    website/status.php
-)
-
-set(CUSTOMSCRIPTS
-    utils/country_languages.php
-    utils/importWikipedia.php
-    utils/export.php
-    utils/query.php
-    utils/server_compare.php
-    utils/setup.php
-    utils/specialphrases.php
-    utils/update.php
-    utils/warm.php
-   )
-
-foreach (script_source ${CUSTOMSCRIPTS})
-    configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
-                   ${PROJECT_BINARY_DIR}/${script_source})
-endforeach()
-
-foreach (script_source ${WEBSITESCRIPTS})
-    configure_file(${PROJECT_SOURCE_DIR}/cmake/website.tmpl
-                   ${PROJECT_BINARY_DIR}/${script_source})
-endforeach()
-
-set(CONFIGUREFILES
-    settings/phrase_settings.php
-    settings/defaults.php
-   )
-
-foreach (cfile ${CONFIGUREFILES})
-    configure_file(${PROJECT_SOURCE_DIR}/${cfile} ${PROJECT_BINARY_DIR}/${cfile})
-endforeach()
-
-set(WEBPATHS css images js)
-
-foreach (wp ${WEBPATHS})
-    execute_process(
-        COMMAND ln -sf ${PROJECT_SOURCE_DIR}/website/${wp} ${PROJECT_BINARY_DIR}/website/
-    )
-endforeach()
+if (BUILD_TESTS)
+    include(CTest)
+
+    set(TEST_BDD db osm2pgsql api)
+
+    find_program(PYTHON_BEHAVE behave)
+    find_program(PYLINT NAMES pylint3 pylint)
+    find_program(PYTEST NAMES pytest py.test-3 py.test)
+    find_program(PHPCS phpcs)
+    find_program(PHPUNIT phpunit)
+
+    if (PYTHON_BEHAVE)
+        message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
+        foreach (test ${TEST_BDD})
+            add_test(NAME bdd_${test}
+                     COMMAND ${PYTHON_BEHAVE} ${test}
+                     WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
+            set_tests_properties(bdd_${test}
+                PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
+        endforeach()
+    else()
+        message(WARNING "behave not found. BDD tests disabled." )
+    endif()
+
+    if (PHPUNIT)
+        message(STATUS "Using phpunit binary ${PHPUNIT}")
+        add_test(NAME php
+                 COMMAND ${PHPUNIT} ./
+                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
+    else()
+        message(WARNING "phpunit not found. PHP unit tests disabled." )
+    endif()
+
+    if (PHPCS)
+        message(STATUS "Using phpcs binary ${PHPCS}")
+        add_test(NAME phpcs
+                 COMMAND ${PHPCS} --report-width=120 --colors lib-php
+                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
+    else()
+        message(WARNING "phpcs not found. PHP linting tests disabled." )
+    endif()
+
+    if (PYLINT)
+        message(STATUS "Using pylint binary ${PYLINT}")
+        add_test(NAME pylint
+                 COMMAND ${PYLINT} nominatim
+                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
+    else()
+        message(WARNING "pylint not found. Python linting tests disabled.")
+    endif()
+
+    if (PYTEST)
+        message(STATUS "Using pytest binary ${PYTEST}")
+        add_test(NAME pytest
+                 COMMAND ${PYTEST} test/python
+                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
+    else()
+        message(WARNING "pytest not found. Python tests disabled." )
+    endif()
+endif()

 
 

+#-----------------------------------------------------------------------------
+# Postgres module
+#-----------------------------------------------------------------------------
+
+if (BUILD_MODULE)
+    add_subdirectory(module)
+endif()

 
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------

-#
-# Tests
-#
+# Installation

 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 

-include(CTest)

 
 

-set(TEST_BDD db osm2pgsql api)
+include(GNUInstallDirs)
+set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
+set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
+set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
+set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
+
+if (BUILD_IMPORTER)
+    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
+    install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
+            DESTINATION ${CMAKE_INSTALL_BINDIR}
+            RENAME nominatim)
+
+    if (EXISTS ${PHP_BIN})
+        configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py.tmpl paths-py.installed)
+    else()
+        configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py-no-php.tmpl paths-py.installed)
+    endif()
+
+    foreach (submodule nominatim_db nominatim_api)
+        install(DIRECTORY src/${submodule}
+                DESTINATION ${NOMINATIM_LIBDIR}/lib-python
+                FILES_MATCHING PATTERN "*.py"
+                PATTERN "paths.py" EXCLUDE
+                PATTERN __pycache__ EXCLUDE)
+        install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed
+                DESTINATION ${NOMINATIM_LIBDIR}/lib-python/${submodule}
+                RENAME paths.py)
+    endforeach()
+
+    install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
+
+    install(FILES ${COUNTRY_GRID_FILE}
+                  data/words.sql
+            DESTINATION ${NOMINATIM_DATADIR})
+endif()

 
 

-foreach (test ${TEST_BDD})
-    add_test(NAME bdd_${test}
-             COMMAND lettuce features/${test}
-             WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests)
-    set_tests_properties(bdd_${test}
-        PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
-endforeach()
+if (BUILD_OSM2PGSQL)
+    if (${CMAKE_VERSION} VERSION_LESS 3.13)
+        # Installation of subdirectory targets was only introduced in 3.13.
+        # So just copy the osm2pgsql file for older versions.
+        install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
+                DESTINATION ${NOMINATIM_LIBDIR})
+    else()
+        install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
+    endif()
+endif()

 
 

-add_test(NAME php
-         COMMAND phpunit ./
-         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests-php)
+if (BUILD_MODULE)
+    install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
+            DESTINATION ${NOMINATIM_LIBDIR}/module)
+endif()

 
 

-#-----------------------------------------------------------------------------
+if (BUILD_API AND EXISTS ${PHP_BIN})
+    install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
+endif()

 
 

-add_subdirectory(module)
-add_subdirectory(nominatim)
-add_subdirectory(docs)
+install(FILES settings/env.defaults
+              settings/address-levels.json
+              settings/phrase-settings.json
+              settings/import-admin.lua
+              settings/import-street.lua
+              settings/import-address.lua
+              settings/import-full.lua
+              settings/import-extratags.lua
+              settings/flex-base.lua
+              settings/icu_tokenizer.yaml
+              settings/country_settings.yaml
+        DESTINATION ${NOMINATIM_CONFIGDIR})
+
+install(DIRECTORY settings/icu-rules
+        DESTINATION ${NOMINATIM_CONFIGDIR})
+install(DIRECTORY settings/country-names
+        DESTINATION ${NOMINATIM_CONFIGDIR})
+
+if (INSTALL_MUNIN_PLUGINS)
+    install(FILES munin/nominatim_importlag
+                  munin/nominatim_query_speed
+                  munin/nominatim_requests
+            DESTINATION ${NOMINATIM_MUNINDIR})
+endif()

 
 

-#-----------------------------------------------------------------------------
+message(WARNING "Building with CMake is deprecated and will be removed in Nominatim 5.0."
+                "Use Nominatim pip packages instead.\n"
+                "See https://nominatim.org/release-docs/develop/admin/Installation/#downloading-and-building-nominatim")