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 3)
  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 # Targets for running a development webserver from the build directory.
 119 #-----------------------------------------------------------------------------
 120
 121 if (BUILD_API)
 122    set(WEBSITEFILES
 123        403.html
 124        509.html
 125        crossdomain.xml
 126        favicon.ico
 127        nominatim.xml
 128        robots.txt
 129        taginfo.json
 130    )
 131
 132    foreach (webfile ${WEBSITEFILES})
 133        configure_file(${PROJECT_SOURCE_DIR}/website/${webfile}
 134                       ${PROJECT_BINARY_DIR}/website/${webfile})
 135    endforeach()
 136 endif()
 137
 138 #-----------------------------------------------------------------------------
 139 # Tests
 140 #-----------------------------------------------------------------------------
 141
 142 if (BUILD_TESTS)
 143     include(CTest)
 144
 145     set(TEST_BDD db osm2pgsql api)
 146
 147     find_program(PYTHON_BEHAVE behave)
 148     find_program(PYLINT NAMES pylint3 pylint)
 149     find_program(PYTEST NAMES pytest py.test-3 py.test)
 150     find_program(PHPCS phpcs)
 151     find_program(PHPUNIT phpunit)
 152
 153     if (PYTHON_BEHAVE)
 154         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 155         foreach (test ${TEST_BDD})
 156             add_test(NAME bdd_${test}
 157                      COMMAND ${PYTHON_BEHAVE} ${test}
 158                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 159             set_tests_properties(bdd_${test}
 160                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 161         endforeach()
 162     else()
 163         message(WARNING "behave not found. BDD tests disabled." )
 164     endif()
 165
 166     if (PHPUNIT)
 167         message(STATUS "Using phpunit binary ${PHPUNIT}")
 168         add_test(NAME php
 169                  COMMAND ${PHPUNIT} ./
 170                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 171     else()
 172         message(WARNING "phpunit not found. PHP unit tests disabled." )
 173     endif()
 174
 175     if (PHPCS)
 176         message(STATUS "Using phpcs binary ${PHPCS}")
 177         add_test(NAME phpcs
 178                  COMMAND ${PHPCS} --report-width=120 --colors lib-php
 179                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 180     else()
 181         message(WARNING "phpcs not found. PHP linting tests disabled." )
 182     endif()
 183
 184     if (PYLINT)
 185         message(STATUS "Using pylint binary ${PYLINT}")
 186         add_test(NAME pylint
 187                  COMMAND ${PYLINT} nominatim
 188                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 189     else()
 190         message(WARNING "pylint not found. Python linting tests disabled.")
 191     endif()
 192
 193     if (PYTEST)
 194         message(STATUS "Using pytest binary ${PYTEST}")
 195         add_test(NAME pytest
 196                  COMMAND ${PYTEST} test/python
 197                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 198     else()
 199         message(WARNING "pytest not found. Python tests disabled." )
 200     endif()
 201 endif()
 202
 203 #-----------------------------------------------------------------------------
 204 # Postgres module
 205 #-----------------------------------------------------------------------------
 206
 207 if (BUILD_MODULE)
 208     add_subdirectory(module)
 209 endif()
 210
 211 #-----------------------------------------------------------------------------
 212 # Documentation
 213 #-----------------------------------------------------------------------------
 214
 215 if (BUILD_DOCS)
 216    add_subdirectory(docs)
 217 endif()
 218
 219 #-----------------------------------------------------------------------------
 220 # Manual page
 221 #-----------------------------------------------------------------------------
 222
 223 if (BUILD_MANPAGE)
 224    add_subdirectory(man)
 225 endif()
 226
 227 #-----------------------------------------------------------------------------
 228 # Installation
 229 #-----------------------------------------------------------------------------
 230
 231
 232 include(GNUInstallDirs)
 233 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 234 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 235 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 236 set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
 237
 238 if (BUILD_IMPORTER)
 239     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 240     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 241             DESTINATION ${CMAKE_INSTALL_BINDIR}
 242             RENAME nominatim)
 243
 244     install(DIRECTORY nominatim
 245             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 246             FILES_MATCHING PATTERN "*.py"
 247             PATTERN "paths.py" EXCLUDE
 248             PATTERN __pycache__ EXCLUDE)
 249
 250     configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py.tmpl paths-py.installed)
 251     install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed
 252             DESTINATION ${NOMINATIM_LIBDIR}/lib-python/nominatim
 253             RENAME paths.py)
 254
 255     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 256
 257     install(FILES ${COUNTRY_GRID_FILE}
 258                   data/words.sql
 259             DESTINATION ${NOMINATIM_DATADIR})
 260 endif()
 261
 262 if (BUILD_OSM2PGSQL)
 263     if (${CMAKE_VERSION} VERSION_LESS 3.13)
 264         # Installation of subdirectory targets was only introduced in 3.13.
 265         # So just copy the osm2pgsql file for older versions.
 266         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
 267                 DESTINATION ${NOMINATIM_LIBDIR})
 268     else()
 269         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 270     endif()
 271 endif()
 272
 273 if (BUILD_MODULE)
 274     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 275             DESTINATION ${NOMINATIM_LIBDIR}/module)
 276 endif()
 277
 278 if (BUILD_API)
 279     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 280 endif()
 281
 282 install(FILES settings/env.defaults
 283               settings/address-levels.json
 284               settings/phrase-settings.json
 285               settings/import-admin.lua
 286               settings/import-street.lua
 287               settings/import-address.lua
 288               settings/import-full.lua
 289               settings/import-extratags.lua
 290               settings/flex-base.lua
 291               settings/icu_tokenizer.yaml
 292               settings/country_settings.yaml
 293         DESTINATION ${NOMINATIM_CONFIGDIR})
 294
 295 install(DIRECTORY settings/icu-rules
 296         DESTINATION ${NOMINATIM_CONFIGDIR})
 297 install(DIRECTORY settings/country-names
 298         DESTINATION ${NOMINATIM_CONFIGDIR})
 299
 300 if (INSTALL_MUNIN_PLUGINS)
 301     install(FILES munin/nominatim_importlag
 302                   munin/nominatim_query_speed
 303                   munin/nominatim_requests
 304             DESTINATION ${NOMINATIM_MUNINDIR})
 305 endif()