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