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