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 2)
  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)
  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 OR BUILD_IMPORTER)
  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(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
  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 # Documentation
 192 #-----------------------------------------------------------------------------
 193
 194 if (BUILD_DOCS)
 195    add_subdirectory(docs)
 196 endif()
 197
 198 #-----------------------------------------------------------------------------
 199 # Manual page
 200 #-----------------------------------------------------------------------------
 201
 202 if (BUILD_MANPAGE)
 203    add_subdirectory(man)
 204 endif()
 205
 206 #-----------------------------------------------------------------------------
 207 # Installation
 208 #-----------------------------------------------------------------------------
 209
 210
 211 include(GNUInstallDirs)
 212 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 213 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 214 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 215 set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
 216
 217 if (BUILD_IMPORTER)
 218     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 219     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 220             DESTINATION ${CMAKE_INSTALL_BINDIR}
 221             RENAME nominatim)
 222
 223     install(DIRECTORY nominatim
 224             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 225             FILES_MATCHING PATTERN "*.py"
 226             PATTERN "paths.py" EXCLUDE
 227             PATTERN __pycache__ EXCLUDE)
 228
 229     configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py.tmpl paths-py.installed)
 230     install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed
 231             DESTINATION ${NOMINATIM_LIBDIR}/lib-python/nominatim
 232             RENAME paths.py)
 233
 234     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 235
 236     install(FILES ${COUNTRY_GRID_FILE}
 237                   data/words.sql
 238             DESTINATION ${NOMINATIM_DATADIR})
 239 endif()
 240
 241 if (BUILD_OSM2PGSQL)
 242     if (${CMAKE_VERSION} VERSION_LESS 3.13)
 243         # Installation of subdirectory targets was only introduced in 3.13.
 244         # So just copy the osm2pgsql file for older versions.
 245         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
 246                 DESTINATION ${NOMINATIM_LIBDIR})
 247     else()
 248         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 249     endif()
 250 endif()
 251
 252 if (BUILD_MODULE)
 253     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 254             DESTINATION ${NOMINATIM_LIBDIR}/module)
 255 endif()
 256
 257 if (BUILD_API)
 258     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 259 endif()
 260
 261 install(FILES settings/env.defaults
 262               settings/address-levels.json
 263               settings/phrase-settings.json
 264               settings/import-admin.lua
 265               settings/import-street.lua
 266               settings/import-address.lua
 267               settings/import-full.lua
 268               settings/import-extratags.lua
 269               settings/flex-base.lua
 270               settings/icu_tokenizer.yaml
 271               settings/country_settings.yaml
 272         DESTINATION ${NOMINATIM_CONFIGDIR})
 273
 274 install(DIRECTORY settings/icu-rules
 275         DESTINATION ${NOMINATIM_CONFIGDIR})
 276 install(DIRECTORY settings/country-names
 277         DESTINATION ${NOMINATIM_CONFIGDIR})
 278
 279 if (INSTALL_MUNIN_PLUGINS)
 280     install(FILES munin/nominatim_importlag
 281                   munin/nominatim_query_speed
 282                   munin/nominatim_requests
 283             DESTINATION ${NOMINATIM_MUNINDIR})
 284 endif()