cmake_minimum_required(VERSION 3.13)

project(DATUM VERSION 0.4.1 LANGUAGES C)

# Enable C23 if supported, else fall back to C11 for compatibility
if(CMAKE_VERSION VERSION_LESS "3.21")
    # Older CMake: C23 not recognized; use C11
    set(CMAKE_C_STANDARD 11)
    set(CMAKE_C_STANDARD_REQUIRED ON)
else()
    # CMake 3.21+: C23 is available
    set(CMAKE_C_STANDARD 23)
    set(CMAKE_C_STANDARD_REQUIRED OFF)
endif()

option(ENABLE_API "Build API support." ON)
option(KACHIE_BUILD_TESTS "Build and register Kachie recovery and setup tests." OFF)

include(GNUInstallDirs)

# The *_tests.c units are the embedded self-tests behind `datum_gateway --test`.
# They use test hooks that only KACHIE_BUILD_TESTS=ON compiles in (see the end
# of this file), so they are part of the gateway only in that configuration.
# The default, Docker and Debian builds leave them out; their `--test` reports
# that the build has no self-tests. With tests ON the source list and its order
# are unchanged, so the tested and deployed binary is the same as before.
set(DATUM_GATEWAY_SOURCES
	src/datum_admission.c
	src/datum_blocktemplates.c
	src/datum_blocktemplates_tests.c
	src/datum_coinbaser.c
	src/kachie_strict.c
	src/kachie_share_cache.c
	src/kachie_candidate.c
	src/kachie_abw_spool.c
	src/datum_coinbaser_tests.c
	src/datum_conf.c
	src/datum_conf_tests.c
	src/datum_gateway.c
	src/datum_gateway_tests.c
	src/datum_jsonrpc.c
	src/datum_jsonrpc_tests.c
	src/datum_logger.c
	src/datum_parent_fetch.c
	src/datum_parent_fetch_tests.c
	src/datum_pow.c
	src/datum_pow_tests.c
	src/datum_protocol.c
	src/datum_protocol_tests.c
	src/datum_queue.c
	src/datum_sockets.c
	src/datum_stratum.c
	src/datum_stratum_dupes.c
	src/datum_stratum_dupes_tests.c
	src/datum_stratum_tests.c
	src/datum_submitblock.c
	src/datum_submitblock_tests.c
	src/datum_utils.c
	src/datum_utils_tests.c
	src/thirdparty_base58.c
	src/thirdparty_segwit_addr.c
)
if(NOT KACHIE_BUILD_TESTS)
	list(FILTER DATUM_GATEWAY_SOURCES EXCLUDE REGEX "_tests\\.c$")
endif()
add_executable(datum_gateway
	${DATUM_GATEWAY_SOURCES}
	${CMAKE_CURRENT_BINARY_DIR}/web_resources.h
)
install(TARGETS datum_gateway DESTINATION bin)

set(WEB_RESOURCES
	www/auth_failed.html
	www/home.html
	www/clients_top.html
	www/coinbaser_top.html
	www/config.html
	www/config_errors.html
	www/config_noauth_top.html
	www/config_restart.html
	www/threads_top.html
	www/foot.html
	www/assets/post.js
	www/assets/i18n.js
	www/assets/style.css
	www/assets/icons/datum_logo.svg
	www/assets/icons/favicon.ico
)

find_package(PkgConfig REQUIRED)
pkg_check_modules(CURL REQUIRED libcurl)
pkg_check_modules(JANSSON REQUIRED jansson)
if(ENABLE_API)
pkg_check_modules(MICROHTTPD REQUIRED libmicrohttpd)
endif()
pkg_check_modules(SODIUM REQUIRED libsodium)
find_package(Threads REQUIRED)

include(CheckFunctionExists)
include(CheckLibraryExists)
include(CheckSymbolExists)
include(CMakePushCheckState)
cmake_push_check_state(RESET)
string(APPEND CMAKE_REQUIRED_FLAGS -Wno-error)

if(APPLE)
	if(CMAKE_OSX_DEPLOYMENT_TARGET AND CMAKE_OSX_DEPLOYMENT_TARGET VERSION_LESS "10.12")
		message(FATAL_ERROR "Kachie requires macOS 10.12 or later for exclusive candidate publication.")
	endif()
	check_symbol_exists(renameatx_np "stdio.h" HAVE_RENAMEATX_NP)
	check_symbol_exists(RENAME_EXCL "stdio.h" HAVE_RENAME_EXCL)
	check_symbol_exists(F_FULLFSYNC "fcntl.h" HAVE_FULLFSYNC)
	if(NOT HAVE_RENAMEATX_NP OR NOT HAVE_RENAME_EXCL OR NOT HAVE_FULLFSYNC)
		message(FATAL_ERROR "Kachie requires a macOS SDK with renameatx_np, RENAME_EXCL and F_FULLFSYNC (macOS 10.12 or later).")
	endif()
endif()

set(POW_LIBS "")
check_library_exists(m pow "" LIBM)
if(LIBM)
	list(APPEND POW_LIBS "m")
endif()



set(ARGP_LIBS "")
set(ARGP_INCLUDE_DIRS "")
check_function_exists(argp_parse HAVE_ARGP_PARSE)
if(NOT HAVE_ARGP_PARSE)
	find_path(ARGP_INCLUDE_DIR argp.h
		HINTS
		/opt/homebrew/opt/argp-standalone
		/usr/local/opt/argp-standalone
		/usr/local
		PATH_SUFFIXES include
	)
	find_library(ARGP_LIBRARY argp
		HINTS
		/opt/homebrew/opt/argp-standalone
		/usr/local/opt/argp-standalone
		/usr/local
		PATH_SUFFIXES lib
	)
	if(ARGP_INCLUDE_DIR AND ARGP_LIBRARY)
		list(APPEND ARGP_INCLUDE_DIRS "${ARGP_INCLUDE_DIR}")
		list(APPEND ARGP_LIBS "${ARGP_LIBRARY}")
	else()
		check_library_exists(argp argp_parse "" ARGP)
		if(NOT ARGP AND CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
			# Workaround bug where CMake doesn't check the standard install location on FreeBSD
			unset(ARGP CACHE)
			check_library_exists(argp argp_parse "/usr/local/lib" ARGP)
		endif()
		if(ARGP)
			list(APPEND ARGP_LIBS "argp")
		endif()
	endif()
endif()

check_symbol_exists(pthread_mutex_timedlock "pthread.h" HAVE_PTHREAD_MUTEX_TIMEDLOCK)
if(HAVE_PTHREAD_MUTEX_TIMEDLOCK)
	target_compile_definitions(datum_gateway PRIVATE HAVE_PTHREAD_MUTEX_TIMEDLOCK)
endif()

if(APPLE)
	check_symbol_exists(pthread_cond_timedwait_relative_np "pthread.h"
		HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE_NP)
	if(NOT HAVE_PTHREAD_COND_TIMEDWAIT_RELATIVE_NP)
		message(FATAL_ERROR "Kachie requires pthread_cond_timedwait_relative_np on macOS")
	endif()
else()
	check_symbol_exists(pthread_condattr_setclock "pthread.h;time.h"
		HAVE_PTHREAD_CONDATTR_SETCLOCK)
	if(NOT HAVE_PTHREAD_CONDATTR_SETCLOCK)
		message(FATAL_ERROR "Kachie requires monotonic pthread condition clocks")
	endif()
	target_compile_definitions(datum_gateway PRIVATE
		HAVE_PTHREAD_CONDATTR_SETCLOCK)
endif()

check_function_exists(epoll_wait HAVE_EPOLL_WAIT)
if(HAVE_EPOLL_WAIT)
	set(EPOLL_SHIM_INCLUDE_DIRS "")
	set(EPOLL_SHIM_LIBRARIES "")
else()
	pkg_check_modules(EPOLL_SHIM REQUIRED epoll-shim)
endif()

cmake_pop_check_state()

add_custom_target(generate_git_version
	BYPRODUCTS ${PROJECT_BINARY_DIR}/git_version.h
	COMMAND ${CMAKE_COMMAND} -DBUILD_INFO_HEADER_PATH=${PROJECT_BINARY_DIR}/git_version.h -DSOURCE_DIR=${PROJECT_SOURCE_DIR} -P ${PROJECT_SOURCE_DIR}/cmake/script/GenerateBuildInfo.cmake
	DEPENDS cmake/script/GenerateBuildInfo.cmake
	COMMENT "Generating git_version.h"
	VERBATIM
)
add_dependencies(datum_gateway generate_git_version)

add_custom_command(
	OUTPUT web_resources.h
	COMMAND ${CMAKE_COMMAND} "-DINPUT_FILES=${WEB_RESOURCES}" -DOUTPUT_FILE=web_resources.h -DSOURCE_DIR=${PROJECT_SOURCE_DIR} -P ${PROJECT_SOURCE_DIR}/cmake/script/EmbedResources.cmake
	DEPENDS ${WEB_RESOURCES} cmake/script/EmbedResources.cmake
	VERBATIM
)

target_include_directories(datum_gateway
	PRIVATE
	$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
	${ARGP_INCLUDE_DIRS}
	${EPOLL_SHIM_INCLUDE_DIRS}
	${CURL_INCLUDE_DIRS}
	${JANSSON_INCLUDE_DIRS}
	${SODIUM_INCLUDE_DIRS}
)
target_link_directories(datum_gateway
	PUBLIC
	${EPOLL_SHIM_LIBRARY_DIRS}
	${CURL_LIBRARY_DIRS}
	${JANSSON_LIBRARY_DIRS}
	${SODIUM_LIBRARY_DIRS}
)
target_link_libraries(datum_gateway
	PUBLIC
	${POW_LIBS}
	Threads::Threads
	${ARGP_LIBS}
	${EPOLL_SHIM_LIBRARIES}
	${CURL_LIBRARIES} ${CURL_LDFLAGS} ${CURL_LDFLAGS_OTHER}
	${JANSSON_LIBRARIES} ${JANSSON_LDFLAGS} ${JANSSON_LDFLAGS_OTHER}
	${SODIUM_LIBRARIES} ${SODIUM_LDFLAGS} ${SODIUM_LDFLAGS_OTHER}
)
target_compile_options(datum_gateway
	PUBLIC
	${CURL_CFLAGS} ${CURL_CFLAGS_OTHER}
	${JANSSON_CFLAGS} ${JANSSON_CFLAGS_OTHER}
	${SODIUM_CFLAGS} ${SODIUM_CFLAGS_OTHER}
)

if(ENABLE_API)
	target_sources(datum_gateway PRIVATE src/datum_api.c)
	target_include_directories(datum_gateway PRIVATE ${MICROHTTPD_INCLUDE_DIRS})
	target_link_directories(datum_gateway PUBLIC ${MICROHTTPD_LIBRARY_DIRS})
	target_link_libraries(datum_gateway PUBLIC ${MICROHTTPD_LIBRARIES} ${MICROHTTPD_LDFLAGS} ${MICROHTTPD_LDFLAGS_OTHER})
	target_compile_options(datum_gateway PUBLIC
		-DENABLE_API
		${MICROHTTPD_CFLAGS} ${MICROHTTPD_CFLAGS_OTHER}
	)
endif()

install(FILES README.md DESTINATION ${CMAKE_INSTALL_DOCDIR})
install(FILES doc/DATUM_recommended_setup-network_diagram.svg DESTINATION ${CMAKE_INSTALL_DOCDIR}/doc)
install(FILES doc/usernames.md DESTINATION ${CMAKE_INSTALL_DOCDIR}/doc)

set(PREGEN_DOC ${CMAKE_SOURCE_DIR}/doc/example_datum_gateway_config.json)
install(FILES ${PREGEN_DOC} DESTINATION ${CMAKE_INSTALL_DOCDIR})

if(NOT CMAKE_CROSSCOMPILING)
	set(GENERATED_DOC ${CMAKE_BINARY_DIR}/CMakeFiles/generated_example_datum_gateway_config.json)
	
	add_custom_command(
		TARGET datum_gateway
		POST_BUILD
		COMMAND ${CMAKE_COMMAND} -DDATUM_GATEWAY=$<TARGET_FILE:datum_gateway> -DGENERATED_DOC=${GENERATED_DOC} -DPREGEN_DOC=${PREGEN_DOC} -P ${PROJECT_SOURCE_DIR}/cmake/script/VerifyExample.cmake
		COMMENT "Verifying pre-generated documentation is up-to-date"
		VERBATIM
	)
endif()

if(KACHIE_BUILD_TESTS)
	enable_testing()
	find_package(Python3 COMPONENTS Interpreter REQUIRED)
	target_compile_definitions(datum_gateway PRIVATE
		KACHIE_SUBMITBLOCK_TESTING KACHIE_GATEWAY_SELF_TESTS)
	# The gateway's embedded self-tests also contain ordinary assert() checks.
	# Keep those active without changing assertions in its production sources.
	get_target_property(KACHIE_GATEWAY_SOURCES datum_gateway SOURCES)
	foreach(source IN LISTS KACHIE_GATEWAY_SOURCES)
		if(source MATCHES "_tests\\.c$")
			set_property(SOURCE "${source}" APPEND PROPERTY COMPILE_OPTIONS -UNDEBUG)
		endif()
	endforeach()
	# Exercise the real submit path with mocked PoW, durable receipt and node I/O.
	# Including datum_stratum.c in the test unit makes the mocks portable to macOS.
	set(KACHIE_SUBMIT_SOURCES ${KACHIE_GATEWAY_SOURCES})
	list(REMOVE_ITEM KACHIE_SUBMIT_SOURCES src/datum_stratum.c src/datum_gateway.c)
	file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/kachie_submit_gateway.c"
		"#define main kachie_unused_gateway_main\n#include \"${CMAKE_CURRENT_SOURCE_DIR}/src/datum_gateway.c\"\n")
	add_executable(kachie_submit_tests ${KACHIE_SUBMIT_SOURCES}
		src/kachie_submit_tests.c "${CMAKE_CURRENT_BINARY_DIR}/kachie_submit_gateway.c")
	foreach(prop INCLUDE_DIRECTORIES COMPILE_DEFINITIONS COMPILE_OPTIONS LINK_LIBRARIES LINK_DIRECTORIES)
		get_target_property(value datum_gateway ${prop})
		if(value)
			set_property(TARGET kachie_submit_tests PROPERTY ${prop} "${value}")
		endif()
	endforeach()
	target_compile_options(kachie_submit_tests PRIVATE -UNDEBUG)
	add_dependencies(kachie_submit_tests generate_git_version)
	add_test(NAME kachie_submit COMMAND kachie_submit_tests)
	# Real ABW protocol + archive; only the asynchronous node queue is controlled.
	set(KACHIE_ABW_SOURCES ${KACHIE_GATEWAY_SOURCES})
	list(REMOVE_ITEM KACHIE_ABW_SOURCES src/datum_protocol.c src/datum_gateway.c)
	add_executable(kachie_abw_tests ${KACHIE_ABW_SOURCES}
		src/kachie_abw_tests.c "${CMAKE_CURRENT_BINARY_DIR}/kachie_submit_gateway.c")
	foreach(prop INCLUDE_DIRECTORIES COMPILE_DEFINITIONS COMPILE_OPTIONS LINK_LIBRARIES LINK_DIRECTORIES)
		get_target_property(value datum_gateway ${prop})
		if(value)
			set_property(TARGET kachie_abw_tests PROPERTY ${prop} "${value}")
		endif()
	endforeach()
	target_compile_definitions(kachie_abw_tests PRIVATE
		KACHIE_CANDIDATE_TESTING KACHIE_ABW_SPOOL_TESTING)
	target_compile_options(kachie_abw_tests PRIVATE -UNDEBUG)
	add_dependencies(kachie_abw_tests generate_git_version)
	add_test(NAME kachie_abw COMMAND kachie_abw_tests)
	add_executable(kachie_share_cache_tests src/kachie_share_cache.c src/kachie_share_cache_tests.c)
	target_compile_options(kachie_share_cache_tests PRIVATE -UNDEBUG)
	add_test(NAME kachie_share_cache COMMAND kachie_share_cache_tests)
	add_executable(kachie_candidate_tests
		src/kachie_candidate.c
		src/datum_pow.c
		src/kachie_candidate_tests.c
	)
	target_include_directories(kachie_candidate_tests PRIVATE ${SODIUM_INCLUDE_DIRS})
	target_link_directories(kachie_candidate_tests PRIVATE ${SODIUM_LIBRARY_DIRS})
	target_link_libraries(kachie_candidate_tests PRIVATE ${POW_LIBS}
		${SODIUM_LIBRARIES} ${SODIUM_LDFLAGS} ${SODIUM_LDFLAGS_OTHER})
	target_compile_definitions(kachie_candidate_tests PRIVATE
		KACHIE_CANDIDATE_TESTING KACHIE_CANDIDATE_TEST_MAIN)
	# Keep the regression assertions enabled in Release builds too.
	target_compile_options(kachie_candidate_tests PRIVATE -UNDEBUG)
	add_test(NAME kachie_candidate COMMAND kachie_candidate_tests)
	add_executable(kachie_abw_spool_tests
		src/kachie_abw_spool.c
		src/kachie_abw_spool_tests.c
	)
	target_include_directories(kachie_abw_spool_tests PRIVATE ${SODIUM_INCLUDE_DIRS})
	target_link_directories(kachie_abw_spool_tests PRIVATE ${SODIUM_LIBRARY_DIRS})
	target_link_libraries(kachie_abw_spool_tests PRIVATE Threads::Threads
		${SODIUM_LIBRARIES} ${SODIUM_LDFLAGS} ${SODIUM_LDFLAGS_OTHER} ${CMAKE_DL_LIBS})
	target_compile_definitions(kachie_abw_spool_tests PRIVATE KACHIE_ABW_SPOOL_TESTING)
	target_compile_options(kachie_abw_spool_tests PRIVATE -UNDEBUG)
	add_test(NAME kachie_abw_spool COMMAND kachie_abw_spool_tests)
	add_executable(datum_admission_tests
		src/datum_admission.c
		src/datum_admission_tests.c
	)
	target_include_directories(datum_admission_tests PRIVATE ${SODIUM_INCLUDE_DIRS})
	target_link_directories(datum_admission_tests PRIVATE ${SODIUM_LIBRARY_DIRS})
	target_link_libraries(datum_admission_tests PRIVATE Threads::Threads
		${SODIUM_LIBRARIES} ${SODIUM_LDFLAGS} ${SODIUM_LDFLAGS_OTHER})
	target_compile_options(datum_admission_tests PRIVATE -UNDEBUG)
	add_test(NAME datum_admission COMMAND datum_admission_tests)
	add_executable(datum_queue_tests src/datum_queue.c src/datum_queue_tests.c)
	target_compile_definitions(datum_queue_tests PRIVATE KACHIE_QUEUE_TESTING)
	target_compile_options(datum_queue_tests PRIVATE -UNDEBUG)
	target_link_libraries(datum_queue_tests PRIVATE Threads::Threads)
	add_test(NAME datum_queue COMMAND datum_queue_tests)
	add_test(NAME gateway COMMAND datum_gateway --test)
	# R13 #41: the shipped example keeps its payout placeholder, which
	# --validate-config must refuse (it used to report the config valid).
	add_test(NAME kachie_example_conf_refused COMMAND datum_gateway --validate-config
		-c ${CMAKE_CURRENT_SOURCE_DIR}/doc/example_datum_gateway_config.json)
	set_tests_properties(kachie_example_conf_refused PROPERTIES TIMEOUT 30
		PASS_REGULAR_EXPRESSION "mining\\.pool_address is not a valid Bitcoin address")
	add_test(NAME kachie_template_schedule COMMAND ${CMAKE_COMMAND} -E env
		"KACHIE_TEST_CC=${CMAKE_C_COMPILER}"
		"KACHIE_SCHEDULE_TEST_FLAGS=${CMAKE_C_FLAGS} ${CMAKE_EXE_LINKER_FLAGS}" ${Python3_EXECUTABLE}
		${CMAKE_CURRENT_SOURCE_DIR}/tests/test_template_schedule.py)
	set_tests_properties(kachie_template_schedule PROPERTIES TIMEOUT 30)
	add_test(NAME kachie_setup COMMAND ${Python3_EXECUTABLE}
		${CMAKE_CURRENT_SOURCE_DIR}/tests/test_kachie_setup.py)
	add_test(NAME kachie_protocol_lock_scope COMMAND ${CMAKE_COMMAND} -E env
		"KACHIE_TEST_CC=${CMAKE_C_COMPILER}" ${Python3_EXECUTABLE}
		${CMAKE_CURRENT_SOURCE_DIR}/tests/test_protocol_lock_scope.py)
	set_tests_properties(kachie_protocol_lock_scope PROPERTIES TIMEOUT 20)
	if(ENABLE_API)
		# Exercise the real API with HTTP calls replaced by an offline boundary.
		set(KACHIE_API_SOURCES ${KACHIE_GATEWAY_SOURCES})
		list(REMOVE_ITEM KACHIE_API_SOURCES src/datum_api.c src/datum_gateway.c)
		add_executable(kachie_api_tests ${KACHIE_API_SOURCES}
			src/datum_api_tests.c "${CMAKE_CURRENT_BINARY_DIR}/kachie_submit_gateway.c")
		foreach(prop INCLUDE_DIRECTORIES COMPILE_DEFINITIONS COMPILE_OPTIONS LINK_LIBRARIES LINK_DIRECTORIES)
			get_target_property(value datum_gateway ${prop})
			if(value)
				set_property(TARGET kachie_api_tests PROPERTY ${prop} "${value}")
			endif()
		endforeach()
		target_compile_options(kachie_api_tests PRIVATE -UNDEBUG)
		add_dependencies(kachie_api_tests generate_git_version)
		add_test(NAME kachie_api_safety COMMAND kachie_api_tests)
		set_tests_properties(kachie_api_safety PROPERTIES TIMEOUT 90)
		add_test(NAME kachie_api_i18n COMMAND ${CMAKE_COMMAND} -E env
			"KACHIE_TEST_CC=${CMAKE_C_COMPILER}" ${Python3_EXECUTABLE}
			${CMAKE_CURRENT_SOURCE_DIR}/tests/test_api_i18n.py)
		set_tests_properties(kachie_api_i18n PROPERTIES TIMEOUT 90)
	endif()
	set_tests_properties(kachie_submit kachie_share_cache kachie_candidate gateway kachie_setup PROPERTIES TIMEOUT 90)
	set_tests_properties(kachie_abw PROPERTIES TIMEOUT 30)
endif()
