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