CMakeLists.txt

   1 #-----------------------------------------------------------------------------
   2 #
   3 #  CMake Config
   4 #
   5 #  Nominatim
   6 #
   7 #-----------------------------------------------------------------------------
   8
   9 cmake_minimum_required(VERSION 2.8 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    set(CUSTOMSCRIPTS
 101        check_import_finished.php
 102        country_languages.php
 103        export.php
 104        query.php
 105        setup.php
 106        specialphrases.php
 107        update.php
 108        warm.php
 109       )
 110
 111    foreach (script_source ${CUSTOMSCRIPTS})
 112        configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
 113                       ${PROJECT_BINARY_DIR}/utils/${script_source})
 114    endforeach()
 115
 116    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
 117                   ${PROJECT_BINARY_DIR}/nominatim)
 118 endif()
 119
 120 #-----------------------------------------------------------------------------
 121 # Tests
 122 #-----------------------------------------------------------------------------
 123
 124 if (BUILD_TESTS)
 125     include(CTest)
 126
 127     set(TEST_BDD db osm2pgsql api)
 128
 129     find_program(PYTHON_BEHAVE behave)
 130     find_program(PYLINT NAMES pylint3 pylint)
 131     find_program(PYTEST NAMES pytest py.test-3 py.test)
 132     find_program(PHPCS phpcs)
 133     find_program(PHPUNIT phpunit)
 134
 135     if (PYTHON_BEHAVE)
 136         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 137         foreach (test ${TEST_BDD})
 138             add_test(NAME bdd_${test}
 139                      COMMAND ${PYTHON_BEHAVE} ${test}
 140                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 141             set_tests_properties(bdd_${test}
 142                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 143         endforeach()
 144     else()
 145         message(WARNING "behave not found. BDD tests disabled." )
 146     endif()
 147
 148     if (PHPUNIT)
 149         message(STATUS "Using phpunit binary ${PHPUNIT}")
 150         add_test(NAME php
 151                  COMMAND ${PHPUNIT} ./
 152                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 153     else()
 154         message(WARNING "phpunit not found. PHP unit tests disabled." )
 155     endif()
 156
 157     if (PHPCS)
 158         message(STATUS "Using phpcs binary ${PHPCS}")
 159         add_test(NAME phpcs
 160                  COMMAND ${PHPCS} --report-width=120 --colors lib website utils
 161                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 162     else()
 163         message(WARNING "phpcs not found. PHP linting tests disabled." )
 164     endif()
 165
 166     if (PYLINT)
 167         message(STATUS "Using pylint binary ${PYLINT}")
 168         add_test(NAME pylint
 169                  COMMAND ${PYLINT} --extension-pkg-whitelist=osmium nominatim
 170                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 171     else()
 172         message(WARNING "pylint not found. Python linting tests disabled.")
 173     endif()
 174
 175     if (PYTEST)
 176         message(STATUS "Using pytest binary ${PYTEST}")
 177         add_test(NAME pytest
 178                  COMMAND ${PYTEST} test/python
 179                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 180     else()
 181         message(WARNING "pytest not found. Python tests disabled." )
 182     endif()
 183 endif()
 184
 185 #-----------------------------------------------------------------------------
 186 # Postgres module
 187 #-----------------------------------------------------------------------------
 188
 189 if (BUILD_MODULE)
 190     add_subdirectory(module)
 191 endif()
 192
 193 #-----------------------------------------------------------------------------
 194 # Documentation
 195 #-----------------------------------------------------------------------------
 196
 197 if (BUILD_DOCS)
 198    add_subdirectory(docs)
 199 endif()
 200
 201 #-----------------------------------------------------------------------------
 202 # Installation
 203 #-----------------------------------------------------------------------------
 204
 205
 206 include(GNUInstallDirs)
 207 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
 208 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
 209 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
 210
 211 if (BUILD_IMPORTER)
 212     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
 213     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
 214             DESTINATION ${CMAKE_INSTALL_BINDIR}
 215             RENAME nominatim)
 216
 217     install(DIRECTORY nominatim
 218             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
 219             FILES_MATCHING PATTERN "*.py"
 220             PATTERN __pycache__ EXCLUDE)
 221     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
 222
 223     install(FILES data/country_name.sql
 224                   data/country_osm_grid.sql.gz
 225                   data/words.sql
 226             DESTINATION ${NOMINATIM_DATADIR})
 227 endif()
 228
 229 if (BUILD_OSM2PGSQL)
 230     install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
 231 endif()
 232
 233 if (BUILD_MODULE)
 234     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
 235             DESTINATION ${NOMINATIM_LIBDIR}/module)
 236 endif()
 237
 238 if (BUILD_API)
 239     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
 240 endif()
 241
 242 install(FILES settings/env.defaults
 243               settings/address-levels.json
 244               settings/phrase_settings.php
 245               settings/import-admin.style
 246               settings/import-street.style
 247               settings/import-address.style
 248               settings/import-full.style
 249               settings/import-extratags.style
 250         DESTINATION ${NOMINATIM_CONFIGDIR})