]> git.openstreetmap.org Git - nominatim.git/blob - CMakeLists.txt
Merge pull request #2937 from lonvia/python-server-stub
[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.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 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 # Tests
129 #-----------------------------------------------------------------------------
130
131 if (BUILD_TESTS)
132     include(CTest)
133
134     set(TEST_BDD db osm2pgsql api)
135
136     find_program(PYTHON_BEHAVE behave)
137     find_program(PYLINT NAMES pylint3 pylint)
138     find_program(PYTEST NAMES pytest py.test-3 py.test)
139     find_program(PHPCS phpcs)
140     find_program(PHPUNIT phpunit)
141
142     if (PYTHON_BEHAVE)
143         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
144         foreach (test ${TEST_BDD})
145             add_test(NAME bdd_${test}
146                      COMMAND ${PYTHON_BEHAVE} ${test}
147                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
148             set_tests_properties(bdd_${test}
149                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
150         endforeach()
151     else()
152         message(WARNING "behave not found. BDD tests disabled." )
153     endif()
154
155     if (PHPUNIT)
156         message(STATUS "Using phpunit binary ${PHPUNIT}")
157         add_test(NAME php
158                  COMMAND ${PHPUNIT} ./
159                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
160     else()
161         message(WARNING "phpunit not found. PHP unit tests disabled." )
162     endif()
163
164     if (PHPCS)
165         message(STATUS "Using phpcs binary ${PHPCS}")
166         add_test(NAME phpcs
167                  COMMAND ${PHPCS} --report-width=120 --colors lib-php
168                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
169     else()
170         message(WARNING "phpcs not found. PHP linting tests disabled." )
171     endif()
172
173     if (PYLINT)
174         message(STATUS "Using pylint binary ${PYLINT}")
175         add_test(NAME pylint
176                  COMMAND ${PYLINT} nominatim
177                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
178     else()
179         message(WARNING "pylint not found. Python linting tests disabled.")
180     endif()
181
182     if (PYTEST)
183         message(STATUS "Using pytest binary ${PYTEST}")
184         add_test(NAME pytest
185                  COMMAND ${PYTEST} test/python
186                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
187     else()
188         message(WARNING "pytest not found. Python tests disabled." )
189     endif()
190 endif()
191
192 #-----------------------------------------------------------------------------
193 # Postgres module
194 #-----------------------------------------------------------------------------
195
196 if (BUILD_MODULE)
197     add_subdirectory(module)
198 endif()
199
200 #-----------------------------------------------------------------------------
201 # Documentation
202 #-----------------------------------------------------------------------------
203
204 if (BUILD_DOCS)
205    add_subdirectory(docs)
206 endif()
207
208 #-----------------------------------------------------------------------------
209 # Manual page
210 #-----------------------------------------------------------------------------
211
212 if (BUILD_MANPAGE)
213    add_subdirectory(man)
214 endif()
215
216 #-----------------------------------------------------------------------------
217 # Installation
218 #-----------------------------------------------------------------------------
219
220
221 include(GNUInstallDirs)
222 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
223 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
224 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
225 set(NOMINATIM_MUNINDIR ${CMAKE_INSTALL_FULL_DATADIR}/munin/plugins)
226
227 if (BUILD_IMPORTER)
228     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
229     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
230             DESTINATION ${CMAKE_INSTALL_BINDIR}
231             RENAME nominatim)
232
233     install(DIRECTORY nominatim
234             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
235             FILES_MATCHING PATTERN "*.py"
236             PATTERN "paths.py" EXCLUDE
237             PATTERN __pycache__ EXCLUDE)
238
239     configure_file(${PROJECT_SOURCE_DIR}/cmake/paths-py.tmpl paths-py.installed)
240     install(FILES ${PROJECT_BINARY_DIR}/paths-py.installed
241             DESTINATION ${NOMINATIM_LIBDIR}/lib-python/nominatim
242             RENAME paths.py)
243
244     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
245
246     install(FILES ${COUNTRY_GRID_FILE}
247                   data/words.sql
248             DESTINATION ${NOMINATIM_DATADIR})
249 endif()
250
251 if (BUILD_OSM2PGSQL)
252     if (${CMAKE_VERSION} VERSION_LESS 3.13)
253         # Installation of subdirectory targets was only introduced in 3.13.
254         # So just copy the osm2pgsql file for older versions.
255         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
256                 DESTINATION ${NOMINATIM_LIBDIR})
257     else()
258         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
259     endif()
260 endif()
261
262 if (BUILD_MODULE)
263     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
264             DESTINATION ${NOMINATIM_LIBDIR}/module)
265 endif()
266
267 if (BUILD_API)
268     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
269 endif()
270
271 install(FILES settings/env.defaults
272               settings/address-levels.json
273               settings/phrase-settings.json
274               settings/import-admin.lua
275               settings/import-street.lua
276               settings/import-address.lua
277               settings/import-full.lua
278               settings/import-extratags.lua
279               settings/flex-base.lua
280               settings/icu_tokenizer.yaml
281               settings/country_settings.yaml
282         DESTINATION ${NOMINATIM_CONFIGDIR})
283
284 install(DIRECTORY settings/icu-rules
285         DESTINATION ${NOMINATIM_CONFIGDIR})
286 install(DIRECTORY settings/country-names
287         DESTINATION ${NOMINATIM_CONFIGDIR})
288
289 if (INSTALL_MUNIN_PLUGINS)
290     install(FILES munin/nominatim_importlag
291                   munin/nominatim_query_speed
292                   munin/nominatim_requests
293             DESTINATION ${NOMINATIM_MUNINDIR})
294 endif()