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