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