CMakeLists.txt

   1 #-----------------------------------------------------------------------------
   2 #
   3 #  CMake Config
   4 #
   5 #  Nominatim
   6 #
   7 #-----------------------------------------------------------------------------
   8
   9 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
  10 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
  11
  12
  13 #-----------------------------------------------------------------------------
  14 #
  15 #  Project version
  16 #
  17 #-----------------------------------------------------------------------------
  18
  19 project(nominatim)
  20
  21 set(NOMINATIM_VERSION_MAJOR 4)
  22 set(NOMINATIM_VERSION_MINOR 4)
  23 set(NOMINATIM_VERSION_PATCH 0)
  24
  25 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
  26
  27 add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
  28
  29 # Setting GIT_HASH
  30 find_package(Git)
  31 if (GIT_FOUND)
  32     execute_process(
  33         COMMAND "${GIT_EXECUTABLE}" log -1 --format=%h
  34         WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
  35         OUTPUT_VARIABLE GIT_HASH
  36         OUTPUT_STRIP_TRAILING_WHITESPACE
  37         ERROR_QUIET
  38         )
  39 endif()
  40
  41 #-----------------------------------------------------------------------------
  42 #  Configuration
  43 #-----------------------------------------------------------------------------
  44
  45 set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
  46 set(BUILD_API on CACHE BOOL "Build everything for the API server")
  47 set(BUILD_MODULE off CACHE BOOL "Build PostgreSQL module for legacy tokenizer")
  48 set(BUILD_TESTS on CACHE BOOL "Build test suite")
  49 set(BUILD_DOCS on CACHE BOOL "Build documentation")
  50 set(BUILD_MANPAGE on CACHE BOOL "Build Manual Page")
  51 set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
  52 set(INSTALL_MUNIN_PLUGINS on CACHE BOOL "Install Munin plugins for supervising Nominatim")
  53
  54 #-----------------------------------------------------------------------------
  55 #  osm2pgsql (imports/updates only)
  56 #-----------------------------------------------------------------------------
  57
  58 if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
  59     if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
  60         message(FATAL_ERROR "The osm2pgsql directory is empty.\
  61         Did you forget to check out Nominatim recursively?\
  62         \nTry updating submodules with: git submodule update --init")
  63     endif()
  64     set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
  65     set(BUILD_TESTS off)
  66     add_subdirectory(osm2pgsql)
  67     set(BUILD_TESTS ${BUILD_TESTS_SAVED})
  68 endif()
  69
  70
  71 #-----------------------------------------------------------------------------
  72 #  python (imports/updates only)
  73 #-----------------------------------------------------------------------------
  74
  75 if (BUILD_IMPORTER OR BUILD_API)
  76     find_package(PythonInterp 3.7 REQUIRED)
  77 endif()
  78
  79 #-----------------------------------------------------------------------------
  80 # PHP
  81 #-----------------------------------------------------------------------------
  82
  83 # Setting PHP binary variable as to command line (prevailing) or auto detect
  84
  85 if (BUILD_API)
  86     if (NOT PHP_BIN)
  87          find_program (PHP_BIN php)
  88     endif()
  89     # sanity check if PHP binary exists
  90     if (NOT EXISTS ${PHP_BIN})
  91         message(WARNING "PHP binary not found. Only Python frontend can be used.")
  92         set(PHP_BIN "")
  93     else()
  94         message (STATUS "Using PHP binary " ${PHP_BIN})
  95     endif()
  96 endif()
  97
  98 #-----------------------------------------------------------------------------
  99 # import scripts and utilities (importer only)
 100 #-----------------------------------------------------------------------------
 101
 102 if (BUILD_IMPORTER)
 103    find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz
 104              PATHS ${PROJECT_SOURCE_DIR}/data
 105              NO_DEFAULT_PATH
 106              DOC "Location of the country grid file."
 107             )
 108
 109    if (NOT COUNTRY_GRID_FILE)
 110        message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n"
 111                            "    wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz")
 112    endif()
 113
 114    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
 115                   ${PROJECT_BINARY_DIR}/nominatim)
 116 endif()
 117
 118 #-----------------------------------------------------------------------------
 119 # Tests
 120 #-----------------------------------------------------------------------------
 121
 122 if (BUILD_TESTS)
 123     include(CTest)
 124
 125     set(TEST_BDD db osm2pgsql api)
 126
 127     find_program(PYTHON_BEHAVE behave)
 128     find_program(PYLINT NAMES pylint3 pylint)
 129     find_program(PYTEST NAMES pytest py.test-3 py.test)
 130     find_program(PHPCS phpcs)
 131     find_program(PHPUNIT phpunit)
 132
 133     if (PYTHON_BEHAVE)
 134         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 135         foreach (test ${TEST_BDD})
 136             add_test(NAME bdd_${test}
 137                      COMMAND ${PYTHON_BEHAVE} ${test}
 138                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 139             set_tests_properties(bdd_${test}
 140                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 141         endforeach()
 142     else()
 143         message(WARNING "behave not found. BDD tests disabled." )
 144     endif()
 145
 146     if (PHPUNIT)
 147         message(STATUS "Using phpunit binary ${PHPUNIT}")
 148         add_test(NAME php
 149                  COMMAND ${PHPUNIT} ./
 150                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 151     else()
 152         message(WARNING "phpunit not found. PHP unit tests disabled." )
 153     endif()
 154
 155     if (PHPCS)
 156         message(STATUS "Using phpcs binary ${PHPCS}")
 157         add_test(NAME phpcs
 158                  COMMAND ${PHPCS} --report-width=120 --colors lib-php
 159                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 160     else()
 161         message(WARNING "phpcs not found. PHP linting tests disabled." )
 162     endif()
 163
 164     if (PYLINT)
 165         message(STATUS "Using pylint binary ${PYLINT}")
 166         add_test(NAME pylint
 167                  COMMAND ${PYLINT} nominatim
 168                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 169     else()
 170         message(WARNING "pylint not found. Python linting tests disabled.")
 171     endif()
 172
 173     if (PYTEST)
 174         message(STATUS "Using pytest binary ${PYTEST}")
 175         add_test(NAME pytest
 176                  COMMAND ${PYTEST} test/python
 177                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 178     else()
 179         message(WARNING "pytest not found. Python tests disabled." )
 180     endif()
 181 endif()
 182
 183 #-----------------------------------------------------------------------------
 184 # Postgres module
 185 #-----------------------------------------------------------------------------
 186
 187 if (BUILD_MODULE)
 188     add_subdirectory(module)
 189 endif()
 190
 191 #-----------------------------------------------------------------------------
 192 # Documentation
 193 #-----------------------------------------------------------------------------
 194
 195 if (BUILD_DOCS)
 196    add_subdirectory(docs)
 197 endif()
 198
 199 #-----------------------------------------------------------------------------
 200 # Manual page
 201 #-----------------------------------------------------------------------------
 202
 203 if (BUILD_MANPAGE)
 204    add_subdirectory(man)
 205 endif()
 206
 207 #-----------------------------------------------------------------------------
 208 # Installation
 209 #-----------------------------------------------------------------------------
 210
 211
 212 include(GNUInstallDirs)
 213 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 214 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 215 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 216 set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
 217
 218 if (BUILD_IMPORTER)
 219     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 220     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 221             DESTINATION ${CMAKE_INSTALL_BINDIR}
 222             RENAME nominatim)
 223
 224     foreach (submodule nominatim_core nominatim_db nominatim_api)
 225         install(DIRECTORY src/${submodule}
 226                 DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 227                 FILES_MATCHING PATTERN "*.py"
 228                 PATTERN "paths.py" EXCLUDE
 229                 PATTERN __pycache__ EXCLUDE)
 230     endforeach()
 231
 232     if (EXISTS ${PHP_BIN})
 233         configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py.tmpl paths-py.installed)
 234     else()
 235         configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py-no-php.tmpl paths-py.installed)
 236     endif()
 237     install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed
 238             DESTINATION ${NOMINATIM_LIBDIR}/lib-python/nominatim_core
 239             RENAME paths.py)
 240
 241     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 242
 243     install(FILES ${COUNTRY_GRID_FILE}
 244                   data/words.sql
 245             DESTINATION ${NOMINATIM_DATADIR})
 246 endif()
 247
 248 if (BUILD_OSM2PGSQL)
 249     if (${CMAKE_VERSION} VERSION_LESS 3.13)
 250         # Installation of subdirectory targets was only introduced in 3.13.
 251         # So just copy the osm2pgsql file for older versions.
 252         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
 253                 DESTINATION ${NOMINATIM_LIBDIR})
 254     else()
 255         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 256     endif()
 257 endif()
 258
 259 if (BUILD_MODULE)
 260     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 261             DESTINATION ${NOMINATIM_LIBDIR}/module)
 262 endif()
 263
 264 if (BUILD_API AND EXISTS ${PHP_BIN})
 265     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 266 endif()
 267
 268 install(FILES settings/env.defaults
 269               settings/address-levels.json
 270               settings/phrase-settings.json
 271               settings/import-admin.lua
 272               settings/import-street.lua
 273               settings/import-address.lua
 274               settings/import-full.lua
 275               settings/import-extratags.lua
 276               settings/flex-base.lua
 277               settings/icu_tokenizer.yaml
 278               settings/country_settings.yaml
 279         DESTINATION ${NOMINATIM_CONFIGDIR})
 280
 281 install(DIRECTORY settings/icu-rules
 282         DESTINATION ${NOMINATIM_CONFIGDIR})
 283 install(DIRECTORY settings/country-names
 284         DESTINATION ${NOMINATIM_CONFIGDIR})
 285
 286 if (INSTALL_MUNIN_PLUGINS)
 287     install(FILES munin/nominatim_importlag
 288                   munin/nominatim_query_speed
 289                   munin/nominatim_requests
 290             DESTINATION ${NOMINATIM_MUNINDIR})
 291 endif()