X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/2ab9e4acd3a2ceb5ff871b6b6afc786377e8739f..4a2873617dcbaf58ff6135aa7d8dcb115c0cc5ba:/CMakeLists.txt?ds=sidebyside diff --git a/CMakeLists.txt b/CMakeLists.txt index 31a572d6..fdc67ffe 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ # #----------------------------------------------------------------------------- -cmake_minimum_required(VERSION 2.8 FATAL_ERROR) +cmake_minimum_required(VERSION 3.0 FATAL_ERROR) list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake") @@ -19,7 +19,7 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake") project(nominatim) set(NOMINATIM_VERSION_MAJOR 3) -set(NOMINATIM_VERSION_MINOR 4) +set(NOMINATIM_VERSION_MINOR 6) set(NOMINATIM_VERSION_PATCH 0) set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}") @@ -28,107 +28,129 @@ add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}") #----------------------------------------------------------------------------- -# -# Find external dependencies -# +# Configuration #----------------------------------------------------------------------------- -set(BUILD_TESTS off CACHE BOOL "Build test suite" FORCE) -set(WITH_LUA off CACHE BOOL "Build with lua support" FORCE) -set(BUILD_DOCS on CACHE BOOL "Build documentation") -set(BUILD_SERVER on CACHE BOOL "Build API server") +set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database") +set(BUILD_API on CACHE BOOL "Build everything for the API server") set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module") -set(BUILD_NOMINATIM on CACHE BOOL "Build Nominatim executable") -set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql") - -if (BUILD_SERVER) - if (BUILD_OSM2PGSQL) - if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt") - message(FATAL_ERROR "The osm2pgsql directory is empty.\ - Did you forget to check out Nominatim recursively?\ - \nTry updating submodules with: git submodule update --init") - endif() - add_subdirectory(osm2pgsql) - endif() +set(BUILD_TESTS on CACHE BOOL "Build test suite") +set(BUILD_DOCS on CACHE BOOL "Build documentation") +set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)") - find_package(PythonInterp 3) +#----------------------------------------------------------------------------- +# osm2pgsql (imports/updates only) +#----------------------------------------------------------------------------- - find_program(PYOSMIUM pyosmium-get-changes) - if (NOT EXISTS "${PYOSMIUM}") - set(PYOSMIUM_PATH "") - message(WARNING "pyosmium-get-changes not found (required for updates)") - else() - set(PYOSMIUM_PATH "${PYOSMIUM}") - message(STATUS "Using pyosmium-get-changes at ${PYOSMIUM_PATH}") +if (BUILD_IMPORTER AND BUILD_OSM2PGSQL) + if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt") + message(FATAL_ERROR "The osm2pgsql directory is empty.\ + Did you forget to check out Nominatim recursively?\ + \nTry updating submodules with: git submodule update --init") endif() + set(BUILD_TESTS_SAVED "${BUILD_TESTS}") + set(BUILD_TESTS off) + set(WITH_LUA off CACHE BOOL "") + add_subdirectory(osm2pgsql) + set(BUILD_TESTS ${BUILD_TESTS_SAVED}) +endif() + + +#----------------------------------------------------------------------------- +# python (imports/updates only) +#----------------------------------------------------------------------------- + +if (BUILD_IMPORTER) + find_package(PythonInterp 3.5 REQUIRED) +endif() + +#----------------------------------------------------------------------------- +# PHP +#----------------------------------------------------------------------------- +# Setting PHP binary variable as to command line (prevailing) or auto detect - # Setting PHP binary variable as to command line (prevailing) or auto detect +if (BUILD_API OR BUILD_IMPORTER) if (NOT PHP_BIN) find_program (PHP_BIN php) endif() # sanity check if PHP binary exists if (NOT EXISTS ${PHP_BIN}) message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ") + else() + message (STATUS "Using PHP binary " ${PHP_BIN}) + endif() + if (NOT PHPCGI_BIN) + find_program (PHPCGI_BIN php-cgi) + endif() + # sanity check if PHP binary exists + if (NOT EXISTS ${PHPCGI_BIN}) + message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.") + set (PHPCGI_BIN "") + else() + message (STATUS "Using php-cgi binary " ${PHPCGI_BIN}) endif() - message (STATUS "Using PHP binary " ${PHP_BIN}) endif() #----------------------------------------------------------------------------- -# -# Setup settings and paths -# +# import scripts and utilities (importer only) #----------------------------------------------------------------------------- -if (BUILD_SERVER) - set(WEBSITESCRIPTS - website/deletable.php - website/details.php - website/hierarchy.php - website/lookup.php - website/polygons.php - website/reverse.php - website/search.php - website/status.php - ) +if (BUILD_IMPORTER) + find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz + PATHS ${PROJECT_SOURCE_DIR}/data + NO_DEFAULT_PATH + DOC "Location of the country grid file." + ) + + if (NOT COUNTRY_GRID_FILE) + message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n" + " wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz") + endif() set(CUSTOMSCRIPTS - utils/country_languages.php - utils/importWikipedia.php - utils/export.php - utils/query.php - utils/setup.php - utils/specialphrases.php - utils/update.php - utils/warm.php + check_import_finished.php + country_languages.php + export.php + query.php + setup.php + specialphrases.php + update.php + warm.php ) foreach (script_source ${CUSTOMSCRIPTS}) configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl - ${PROJECT_BINARY_DIR}/${script_source}) + ${PROJECT_BINARY_DIR}/utils/${script_source}) endforeach() - foreach (script_source ${WEBSITESCRIPTS}) - configure_file(${PROJECT_SOURCE_DIR}/cmake/website.tmpl - ${PROJECT_BINARY_DIR}/${script_source}) - endforeach() + configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl + ${PROJECT_BINARY_DIR}/nominatim) +endif() - configure_file(${PROJECT_SOURCE_DIR}/settings/defaults.php - ${PROJECT_BINARY_DIR}/settings/settings.php) +#----------------------------------------------------------------------------- +# Targets for running a development webserver from the build directory. +#----------------------------------------------------------------------------- - set(WEBPATHS css images js) +if (BUILD_API) + set(WEBSITEFILES + 403.html + 509.html + crossdomain.xml + favicon.ico + nominatim.xml + robots.txt + taginfo.json + ) - foreach (wp ${WEBPATHS}) - execute_process( - COMMAND ln -sf ${PROJECT_SOURCE_DIR}/website/${wp} ${PROJECT_BINARY_DIR}/website/ - ) + foreach (webfile ${WEBSITEFILES}) + configure_file(${PROJECT_SOURCE_DIR}/website/${webfile} + ${PROJECT_BINARY_DIR}/website/${webfile}) endforeach() endif() #----------------------------------------------------------------------------- -# # Tests -# #----------------------------------------------------------------------------- if (BUILD_TESTS) @@ -136,29 +158,132 @@ if (BUILD_TESTS) set(TEST_BDD db osm2pgsql api) - foreach (test ${TEST_BDD}) - add_test(NAME bdd_${test} - COMMAND lettuce features/${test} - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests) - set_tests_properties(bdd_${test} - PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}") - endforeach() - - add_test(NAME php - COMMAND phpunit ./ - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests-php) + find_program(PYTHON_BEHAVE behave) + find_program(PYLINT NAMES pylint3 pylint) + find_program(PYTEST NAMES pytest py.test-3 py.test) + find_program(PHPCS phpcs) + find_program(PHPUNIT phpunit) + + if (PYTHON_BEHAVE) + message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}") + foreach (test ${TEST_BDD}) + add_test(NAME bdd_${test} + COMMAND ${PYTHON_BEHAVE} ${test} + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd) + set_tests_properties(bdd_${test} + PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}") + endforeach() + else() + message(WARNING "behave not found. BDD tests disabled." ) + endif() + + if (PHPUNIT) + message(STATUS "Using phpunit binary ${PHPUNIT}") + add_test(NAME php + COMMAND ${PHPUNIT} ./ + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php) + else() + message(WARNING "phpunit not found. PHP unit tests disabled." ) + endif() + + if (PHPCS) + message(STATUS "Using phpcs binary ${PHPCS}") + add_test(NAME phpcs + COMMAND ${PHPCS} --report-width=120 --colors lib website utils + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) + else() + message(WARNING "phpcs not found. PHP linting tests disabled." ) + endif() + + if (PYLINT) + message(STATUS "Using pylint binary ${PYLINT}") + add_test(NAME pylint + COMMAND ${PYLINT} nominatim + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) + else() + message(WARNING "pylint not found. Python linting tests disabled.") + endif() + + if (PYTEST) + message(STATUS "Using pytest binary ${PYTEST}") + add_test(NAME pytest + COMMAND ${PYTEST} test/python + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) + else() + message(WARNING "pytest not found. Python tests disabled." ) + endif() endif() +#----------------------------------------------------------------------------- +# Postgres module #----------------------------------------------------------------------------- if (BUILD_MODULE) add_subdirectory(module) endif() -if (BUILD_NOMINATIM) - add_subdirectory(nominatim) -endif() + +#----------------------------------------------------------------------------- +# Documentation +#----------------------------------------------------------------------------- + if (BUILD_DOCS) add_subdirectory(docs) endif() #----------------------------------------------------------------------------- +# Installation +#----------------------------------------------------------------------------- + + +include(GNUInstallDirs) +set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME}) +set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME}) +set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME}) + +if (BUILD_IMPORTER) + configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin) + install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin + DESTINATION ${CMAKE_INSTALL_BINDIR} + RENAME nominatim) + + install(DIRECTORY nominatim + DESTINATION ${NOMINATIM_LIBDIR}/lib-python + FILES_MATCHING PATTERN "*.py" + PATTERN __pycache__ EXCLUDE) + install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR}) + + install(FILES data/country_name.sql + ${COUNTRY_GRID_FILE} + data/words.sql + DESTINATION ${NOMINATIM_DATADIR}) +endif() + +if (BUILD_OSM2PGSQL) + if (${CMAKE_VERSION} VERSION_LESS 3.13) + # Installation of subdirectory targets was only introduced in 3.13. + # So just copy the osm2pgsql file for older versions. + install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql + DESTINATION ${NOMINATIM_LIBDIR}) + else() + install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR}) + endif() +endif() + +if (BUILD_MODULE) + install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so + DESTINATION ${NOMINATIM_LIBDIR}/module) +endif() + +if (BUILD_API) + install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR}) +endif() + +install(FILES settings/env.defaults + settings/address-levels.json + settings/phrase_settings.php + settings/import-admin.style + settings/import-street.style + settings/import-address.style + settings/import-full.style + settings/import-extratags.style + DESTINATION ${NOMINATIM_CONFIGDIR})