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 3)
  22 set(NOMINATIM_VERSION_MINOR 6)
  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
  30 #-----------------------------------------------------------------------------
  31 #  Configuration
  32 #-----------------------------------------------------------------------------
  33
  34 set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
  35 set(BUILD_API on CACHE BOOL "Build everything for the API server")
  36 set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module")
  37 set(BUILD_TESTS on CACHE BOOL "Build test suite")
  38 set(BUILD_DOCS on CACHE BOOL "Build documentation")
  39 set(BUILD_MANPAGE on CACHE BOOL "Build Manual Page")
  40 set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
  41
  42 #-----------------------------------------------------------------------------
  43 #  osm2pgsql (imports/updates only)
  44 #-----------------------------------------------------------------------------
  45
  46 if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
  47     if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
  48         message(FATAL_ERROR "The osm2pgsql directory is empty.\
  49         Did you forget to check out Nominatim recursively?\
  50         \nTry updating submodules with: git submodule update --init")
  51     endif()
  52     set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
  53     set(BUILD_TESTS off)
  54     set(WITH_LUA off CACHE BOOL "")
  55     add_subdirectory(osm2pgsql)
  56     set(BUILD_TESTS ${BUILD_TESTS_SAVED})
  57 endif()
  58
  59
  60 #-----------------------------------------------------------------------------
  61 #  python (imports/updates only)
  62 #-----------------------------------------------------------------------------
  63
  64 if (BUILD_IMPORTER)
  65     find_package(PythonInterp 3.5 REQUIRED)
  66 endif()
  67
  68 #-----------------------------------------------------------------------------
  69 # PHP
  70 #-----------------------------------------------------------------------------
  71
  72 # Setting PHP binary variable as to command line (prevailing) or auto detect
  73
  74 if (BUILD_API OR BUILD_IMPORTER)
  75     if (NOT PHP_BIN)
  76          find_program (PHP_BIN php)
  77     endif()
  78     # sanity check if PHP binary exists
  79     if (NOT EXISTS ${PHP_BIN})
  80         message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
  81     else()
  82         message (STATUS "Using PHP binary " ${PHP_BIN})
  83     endif()
  84     if (NOT PHPCGI_BIN)
  85         find_program (PHPCGI_BIN php-cgi)
  86     endif()
  87     # sanity check if PHP binary exists
  88     if (NOT EXISTS ${PHPCGI_BIN})
  89         message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.")
  90         set (PHPCGI_BIN "")
  91     else()
  92         message (STATUS "Using php-cgi binary " ${PHPCGI_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    set(CUSTOMSCRIPTS
 113        check_import_finished.php
 114        country_languages.php
 115        export.php
 116        query.php
 117        setup.php
 118        update.php
 119        warm.php
 120       )
 121
 122    foreach (script_source ${CUSTOMSCRIPTS})
 123        configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
 124                       ${PROJECT_BINARY_DIR}/utils/${script_source})
 125    endforeach()
 126
 127    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
 128                   ${PROJECT_BINARY_DIR}/nominatim)
 129 endif()
 130
 131 #-----------------------------------------------------------------------------
 132 # Targets for running a development webserver from the build directory.
 133 #-----------------------------------------------------------------------------
 134
 135 if (BUILD_API)
 136    set(WEBSITEFILES
 137        403.html
 138        509.html
 139        crossdomain.xml
 140        favicon.ico
 141        nominatim.xml
 142        robots.txt
 143        taginfo.json
 144    )
 145
 146    foreach (webfile ${WEBSITEFILES})
 147        configure_file(${PROJECT_SOURCE_DIR}/website/${webfile}
 148                       ${PROJECT_BINARY_DIR}/website/${webfile})
 149    endforeach()
 150 endif()
 151
 152 #-----------------------------------------------------------------------------
 153 # Tests
 154 #-----------------------------------------------------------------------------
 155
 156 if (BUILD_TESTS)
 157     include(CTest)
 158
 159     set(TEST_BDD db osm2pgsql api)
 160
 161     find_program(PYTHON_BEHAVE behave)
 162     find_program(PYLINT NAMES pylint3 pylint)
 163     find_program(PYTEST NAMES pytest py.test-3 py.test)
 164     find_program(PHPCS phpcs)
 165     find_program(PHPUNIT phpunit)
 166
 167     if (PYTHON_BEHAVE)
 168         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 169         foreach (test ${TEST_BDD})
 170             add_test(NAME bdd_${test}
 171                      COMMAND ${PYTHON_BEHAVE} ${test}
 172                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 173             set_tests_properties(bdd_${test}
 174                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 175         endforeach()
 176     else()
 177         message(WARNING "behave not found. BDD tests disabled." )
 178     endif()
 179
 180     if (PHPUNIT)
 181         message(STATUS "Using phpunit binary ${PHPUNIT}")
 182         add_test(NAME php
 183                  COMMAND ${PHPUNIT} ./
 184                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 185     else()
 186         message(WARNING "phpunit not found. PHP unit tests disabled." )
 187     endif()
 188
 189     if (PHPCS)
 190         message(STATUS "Using phpcs binary ${PHPCS}")
 191         add_test(NAME phpcs
 192                  COMMAND ${PHPCS} --report-width=120 --colors lib website utils
 193                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 194     else()
 195         message(WARNING "phpcs not found. PHP linting tests disabled." )
 196     endif()
 197
 198     if (PYLINT)
 199         message(STATUS "Using pylint binary ${PYLINT}")
 200         add_test(NAME pylint
 201                  COMMAND ${PYLINT} nominatim
 202                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 203     else()
 204         message(WARNING "pylint not found. Python linting tests disabled.")
 205     endif()
 206
 207     if (PYTEST)
 208         message(STATUS "Using pytest binary ${PYTEST}")
 209         add_test(NAME pytest
 210                  COMMAND ${PYTEST} test/python
 211                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 212     else()
 213         message(WARNING "pytest not found. Python tests disabled." )
 214     endif()
 215 endif()
 216
 217 #-----------------------------------------------------------------------------
 218 # Postgres module
 219 #-----------------------------------------------------------------------------
 220
 221 if (BUILD_MODULE)
 222     add_subdirectory(module)
 223 endif()
 224
 225 #-----------------------------------------------------------------------------
 226 # Documentation
 227 #-----------------------------------------------------------------------------
 228
 229 if (BUILD_DOCS)
 230    add_subdirectory(docs)
 231 endif()
 232
 233 #-----------------------------------------------------------------------------
 234 # Manual page
 235 #-----------------------------------------------------------------------------
 236
 237 if (BUILD_MANPAGE)
 238    add_subdirectory(manual)
 239 endif()
 240
 241 #-----------------------------------------------------------------------------
 242 # Installation
 243 #-----------------------------------------------------------------------------
 244
 245
 246 include(GNUInstallDirs)
 247 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 248 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 249 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 250
 251 if (BUILD_IMPORTER)
 252     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 253     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 254             DESTINATION ${CMAKE_INSTALL_BINDIR}
 255             RENAME nominatim)
 256
 257     install(DIRECTORY nominatim
 258             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 259             FILES_MATCHING PATTERN "*.py"
 260             PATTERN __pycache__ EXCLUDE)
 261     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 262
 263     install(FILES data/country_name.sql
 264                   ${COUNTRY_GRID_FILE}
 265                   data/words.sql
 266             DESTINATION ${NOMINATIM_DATADIR})
 267 endif()
 268
 269 if (BUILD_OSM2PGSQL)
 270     if (${CMAKE_VERSION} VERSION_LESS 3.13)
 271         # Installation of subdirectory targets was only introduced in 3.13.
 272         # So just copy the osm2pgsql file for older versions.
 273         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
 274                 DESTINATION ${NOMINATIM_LIBDIR})
 275     else()
 276         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 277     endif()
 278 endif()
 279
 280 if (BUILD_MODULE)
 281     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 282             DESTINATION ${NOMINATIM_LIBDIR}/module)
 283 endif()
 284
 285 if (BUILD_API)
 286     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 287 endif()
 288
 289 install(FILES settings/env.defaults
 290               settings/address-levels.json
 291               settings/phrase-settings.json
 292               settings/import-admin.style
 293               settings/import-street.style
 294               settings/import-address.style
 295               settings/import-full.style
 296               settings/import-extratags.style
 297         DESTINATION ${NOMINATIM_CONFIGDIR})