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