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