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 0)
  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     set(WITH_LUA off CACHE BOOL "")
  67     add_subdirectory(osm2pgsql)
  68     set(BUILD_TESTS ${BUILD_TESTS_SAVED})
  69 endif()
  70
  71
  72 #-----------------------------------------------------------------------------
  73 #  python (imports/updates only)
  74 #-----------------------------------------------------------------------------
  75
  76 if (BUILD_IMPORTER)
  77     find_package(PythonInterp 3.6 REQUIRED)
  78 endif()
  79
  80 #-----------------------------------------------------------------------------
  81 # PHP
  82 #-----------------------------------------------------------------------------
  83
  84 # Setting PHP binary variable as to command line (prevailing) or auto detect
  85
  86 if (BUILD_API OR BUILD_IMPORTER)
  87     if (NOT PHP_BIN)
  88          find_program (PHP_BIN php)
  89     endif()
  90     # sanity check if PHP binary exists
  91     if (NOT EXISTS ${PHP_BIN})
  92         message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
  93     else()
  94         message (STATUS "Using PHP binary " ${PHP_BIN})
  95     endif()
  96     if (NOT PHPCGI_BIN)
  97         find_program (PHPCGI_BIN php-cgi)
  98     endif()
  99     # sanity check if PHP binary exists
 100     if (NOT EXISTS ${PHPCGI_BIN})
 101         message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.")
 102         set (PHPCGI_BIN "")
 103     else()
 104         message (STATUS "Using php-cgi binary " ${PHPCGI_BIN})
 105     endif()
 106 endif()
 107
 108 #-----------------------------------------------------------------------------
 109 # import scripts and utilities (importer only)
 110 #-----------------------------------------------------------------------------
 111
 112 if (BUILD_IMPORTER)
 113    find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz
 114              PATHS ${PROJECT_SOURCE_DIR}/data
 115              NO_DEFAULT_PATH
 116              DOC "Location of the country grid file."
 117             )
 118
 119    if (NOT COUNTRY_GRID_FILE)
 120        message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n"
 121                            "    wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz")
 122    endif()
 123
 124    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
 125                   ${PROJECT_BINARY_DIR}/nominatim)
 126 endif()
 127
 128 #-----------------------------------------------------------------------------
 129 # Targets for running a development webserver from the build directory.
 130 #-----------------------------------------------------------------------------
 131
 132 if (BUILD_API)
 133    set(WEBSITEFILES
 134        403.html
 135        509.html
 136        crossdomain.xml
 137        favicon.ico
 138        nominatim.xml
 139        robots.txt
 140        taginfo.json
 141    )
 142
 143    foreach (webfile ${WEBSITEFILES})
 144        configure_file(${PROJECT_SOURCE_DIR}/website/${webfile}
 145                       ${PROJECT_BINARY_DIR}/website/${webfile})
 146    endforeach()
 147 endif()
 148
 149 #-----------------------------------------------------------------------------
 150 # Tests
 151 #-----------------------------------------------------------------------------
 152
 153 if (BUILD_TESTS)
 154     include(CTest)
 155
 156     set(TEST_BDD db osm2pgsql api)
 157
 158     find_program(PYTHON_BEHAVE behave)
 159     find_program(PYLINT NAMES pylint3 pylint)
 160     find_program(PYTEST NAMES pytest py.test-3 py.test)
 161     find_program(PHPCS phpcs)
 162     find_program(PHPUNIT phpunit)
 163
 164     if (PYTHON_BEHAVE)
 165         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 166         foreach (test ${TEST_BDD})
 167             add_test(NAME bdd_${test}
 168                      COMMAND ${PYTHON_BEHAVE} ${test}
 169                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 170             set_tests_properties(bdd_${test}
 171                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 172         endforeach()
 173     else()
 174         message(WARNING "behave not found. BDD tests disabled." )
 175     endif()
 176
 177     if (PHPUNIT)
 178         message(STATUS "Using phpunit binary ${PHPUNIT}")
 179         add_test(NAME php
 180                  COMMAND ${PHPUNIT} ./
 181                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 182     else()
 183         message(WARNING "phpunit not found. PHP unit tests disabled." )
 184     endif()
 185
 186     if (PHPCS)
 187         message(STATUS "Using phpcs binary ${PHPCS}")
 188         add_test(NAME phpcs
 189                  COMMAND ${PHPCS} --report-width=120 --colors lib-php
 190                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 191     else()
 192         message(WARNING "phpcs not found. PHP linting tests disabled." )
 193     endif()
 194
 195     if (PYLINT)
 196         message(STATUS "Using pylint binary ${PYLINT}")
 197         add_test(NAME pylint
 198                  COMMAND ${PYLINT} nominatim
 199                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 200     else()
 201         message(WARNING "pylint not found. Python linting tests disabled.")
 202     endif()
 203
 204     if (PYTEST)
 205         message(STATUS "Using pytest binary ${PYTEST}")
 206         add_test(NAME pytest
 207                  COMMAND ${PYTEST} test/python
 208                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 209     else()
 210         message(WARNING "pytest not found. Python tests disabled." )
 211     endif()
 212 endif()
 213
 214 #-----------------------------------------------------------------------------
 215 # Postgres module
 216 #-----------------------------------------------------------------------------
 217
 218 if (BUILD_MODULE)
 219     add_subdirectory(module)
 220 endif()
 221
 222 #-----------------------------------------------------------------------------
 223 # Documentation
 224 #-----------------------------------------------------------------------------
 225
 226 if (BUILD_DOCS)
 227    add_subdirectory(docs)
 228 endif()
 229
 230 #-----------------------------------------------------------------------------
 231 # Manual page
 232 #-----------------------------------------------------------------------------
 233
 234 if (BUILD_MANPAGE)
 235    add_subdirectory(man)
 236 endif()
 237
 238 #-----------------------------------------------------------------------------
 239 # Installation
 240 #-----------------------------------------------------------------------------
 241
 242
 243 include(GNUInstallDirs)
 244 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 245 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 246 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 247 set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
 248
 249 if (BUILD_IMPORTER)
 250     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 251     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 252             DESTINATION ${CMAKE_INSTALL_BINDIR}
 253             RENAME nominatim)
 254
 255     install(DIRECTORY nominatim
 256             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 257             FILES_MATCHING PATTERN "*.py"
 258             PATTERN __pycache__ EXCLUDE)
 259     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 260
 261     install(FILES ${COUNTRY_GRID_FILE}
 262                   data/words.sql
 263             DESTINATION ${NOMINATIM_DATADIR})
 264 endif()
 265
 266 if (BUILD_OSM2PGSQL)
 267     if (${CMAKE_VERSION} VERSION_LESS 3.13)
 268         # Installation of subdirectory targets was only introduced in 3.13.
 269         # So just copy the osm2pgsql file for older versions.
 270         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
 271                 DESTINATION ${NOMINATIM_LIBDIR})
 272     else()
 273         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 274     endif()
 275 endif()
 276
 277 if (BUILD_MODULE)
 278     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 279             DESTINATION ${NOMINATIM_LIBDIR}/module)
 280 endif()
 281
 282 if (BUILD_API)
 283     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 284 endif()
 285
 286 install(FILES settings/env.defaults
 287               settings/address-levels.json
 288               settings/phrase-settings.json
 289               settings/import-admin.style
 290               settings/import-street.style
 291               settings/import-address.style
 292               settings/import-full.style
 293               settings/import-extratags.style
 294               settings/icu_tokenizer.yaml
 295               settings/country_settings.yaml
 296         DESTINATION ${NOMINATIM_CONFIGDIR})
 297
 298 install(DIRECTORY settings/icu-rules
 299         DESTINATION ${NOMINATIM_CONFIGDIR})
 300 install(DIRECTORY settings/country-names
 301         DESTINATION ${NOMINATIM_CONFIGDIR})
 302
 303 if (INSTALL_MUNIN_PLUGINS)
 304     install(FILES munin/nominatim_importlag
 305                   munin/nominatim_query_speed
 306                   munin/nominatim_requests
 307             DESTINATION ${NOMINATIM_MUNINDIR})
 308 endif()