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