From 747adb6ffe9b06d476fc5eaebbaf9a62b91a78c5 Mon Sep 17 00:00:00 2001
From: Hennadii Stepanov <32963518+hebasto@users.noreply.github.com>
Date: Fri, 16 Aug 2024 19:29:34 +0100
Subject: [PATCH] cmake: Add `Maintenance` module

---
 CMakeLists.txt                      |   6 ++
 cmake/module/GenerateSetupNsi.cmake |  18 ++++
 cmake/module/Maintenance.cmake      | 151 ++++++++++++++++++++++++++++
 cmake/script/macos_zip.sh           |  12 +++
 4 files changed, 187 insertions(+)
 create mode 100644 cmake/module/GenerateSetupNsi.cmake
 create mode 100644 cmake/module/Maintenance.cmake
 create mode 100755 cmake/script/macos_zip.sh

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3d43079b33..5c5354d929 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -540,6 +540,12 @@ add_subdirectory(src)
 
 include(cmake/tests.cmake)
 
+include(Maintenance)
+setup_split_debug_script()
+add_maintenance_targets()
+add_windows_deploy_target()
+add_macos_deploy_target()
+
 message("\n")
 message("Configure summary")
 message("=================")
diff --git a/cmake/module/GenerateSetupNsi.cmake b/cmake/module/GenerateSetupNsi.cmake
new file mode 100644
index 0000000000..b7ea423611
--- /dev/null
+++ b/cmake/module/GenerateSetupNsi.cmake
@@ -0,0 +1,18 @@
+# Copyright (c) 2023-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or https://opensource.org/license/mit/.
+
+function(generate_setup_nsi)
+  set(abs_top_srcdir ${PROJECT_SOURCE_DIR})
+  set(abs_top_builddir ${PROJECT_BINARY_DIR})
+  set(PACKAGE_URL ${PROJECT_HOMEPAGE_URL})
+  set(PACKAGE_TARNAME "bitcoin")
+  set(BITCOIN_GUI_NAME "bitcoin-qt")
+  set(BITCOIN_DAEMON_NAME "bitcoind")
+  set(BITCOIN_CLI_NAME "bitcoin-cli")
+  set(BITCOIN_TX_NAME "bitcoin-tx")
+  set(BITCOIN_WALLET_TOOL_NAME "bitcoin-wallet")
+  set(BITCOIN_TEST_NAME "test_bitcoin")
+  set(EXEEXT ${CMAKE_EXECUTABLE_SUFFIX})
+  configure_file(${PROJECT_SOURCE_DIR}/share/setup.nsi.in ${PROJECT_BINARY_DIR}/bitcoin-win64-setup.nsi @ONLY)
+endfunction()
diff --git a/cmake/module/Maintenance.cmake b/cmake/module/Maintenance.cmake
new file mode 100644
index 0000000000..2c6cfc1863
--- /dev/null
+++ b/cmake/module/Maintenance.cmake
@@ -0,0 +1,151 @@
+# Copyright (c) 2023-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or https://opensource.org/license/mit/.
+
+include_guard(GLOBAL)
+
+function(setup_split_debug_script)
+  if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")
+    set(OBJCOPY ${CMAKE_OBJCOPY})
+    set(STRIP ${CMAKE_STRIP})
+    configure_file(
+      contrib/devtools/split-debug.sh.in split-debug.sh
+      FILE_PERMISSIONS OWNER_READ OWNER_EXECUTE
+                       GROUP_READ GROUP_EXECUTE
+                       WORLD_READ
+      @ONLY
+    )
+  endif()
+endfunction()
+
+function(add_maintenance_targets)
+  if(NOT PYTHON_COMMAND)
+    return()
+  endif()
+
+  if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    set(exe_format MACHO)
+  elseif(WIN32)
+    set(exe_format PE)
+  else()
+    set(exe_format ELF)
+  endif()
+
+  # In CMake, the components of the compiler invocation are separated into distinct variables:
+  #  - CMAKE_CXX_COMPILER: the full path to the compiler binary itself (e.g., /usr/bin/clang++).
+  #  - CMAKE_CXX_COMPILER_ARG1: a string containing initial compiler options (e.g., --target=x86_64-apple-darwin -nostdlibinc).
+  # By concatenating these variables, we form the complete command line to be passed to a Python script via the CXX environment variable.
+  string(STRIP "${CMAKE_CXX_COMPILER} ${CMAKE_CXX_COMPILER_ARG1}" cxx_compiler_command)
+  add_custom_target(test-security-check
+    COMMAND ${CMAKE_COMMAND} -E env CXX=${cxx_compiler_command} CXXFLAGS=${CMAKE_CXX_FLAGS} LDFLAGS=${CMAKE_EXE_LINKER_FLAGS} ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/devtools/test-security-check.py TestSecurityChecks.test_${exe_format}
+    COMMAND ${CMAKE_COMMAND} -E env CXX=${cxx_compiler_command} CXXFLAGS=${CMAKE_CXX_FLAGS} LDFLAGS=${CMAKE_EXE_LINKER_FLAGS} ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/devtools/test-symbol-check.py TestSymbolChecks.test_${exe_format}
+    VERBATIM
+  )
+
+  foreach(target IN ITEMS bitcoind bitcoin-qt bitcoin-cli bitcoin-tx bitcoin-util bitcoin-wallet test_bitcoin bench_bitcoin)
+    if(TARGET ${target})
+      list(APPEND executables $<TARGET_FILE:${target}>)
+    endif()
+  endforeach()
+
+  add_custom_target(check-symbols
+    COMMAND ${CMAKE_COMMAND} -E echo "Running symbol and dynamic library checks..."
+    COMMAND ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/devtools/symbol-check.py ${executables}
+    VERBATIM
+  )
+
+  if(ENABLE_HARDENING)
+    add_custom_target(check-security
+      COMMAND ${CMAKE_COMMAND} -E echo "Checking binary security..."
+      COMMAND ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/devtools/security-check.py ${executables}
+      VERBATIM
+    )
+  else()
+    add_custom_target(check-security)
+  endif()
+endfunction()
+
+function(add_windows_deploy_target)
+  if(MINGW AND TARGET bitcoin-qt AND TARGET bitcoind AND TARGET bitcoin-cli AND TARGET bitcoin-tx AND TARGET bitcoin-wallet AND TARGET bitcoin-util AND TARGET test_bitcoin)
+    # TODO: Consider replacing this code with the CPack NSIS Generator.
+    #       See https://cmake.org/cmake/help/latest/cpack_gen/nsis.html
+    include(GenerateSetupNsi)
+    generate_setup_nsi()
+    add_custom_command(
+      OUTPUT ${PROJECT_BINARY_DIR}/bitcoin-win64-setup.exe
+      COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/release
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoin-qt> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoin-qt>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoind> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoind>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoin-cli> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoin-cli>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoin-tx> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoin-tx>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoin-wallet> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoin-wallet>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:bitcoin-util> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:bitcoin-util>
+      COMMAND ${CMAKE_STRIP} $<TARGET_FILE:test_bitcoin> -o ${PROJECT_BINARY_DIR}/release/$<TARGET_FILE_NAME:test_bitcoin>
+      COMMAND makensis -V2 ${PROJECT_BINARY_DIR}/bitcoin-win64-setup.nsi
+      VERBATIM
+    )
+    add_custom_target(deploy DEPENDS ${PROJECT_BINARY_DIR}/bitcoin-win64-setup.exe)
+  endif()
+endfunction()
+
+function(add_macos_deploy_target)
+  if(CMAKE_SYSTEM_NAME STREQUAL "Darwin" AND TARGET bitcoin-qt)
+    set(macos_app "Bitcoin-Qt.app")
+    # Populate Contents subdirectory.
+    configure_file(${PROJECT_SOURCE_DIR}/share/qt/Info.plist.in ${macos_app}/Contents/Info.plist)
+    file(CONFIGURE OUTPUT ${macos_app}/Contents/PkgInfo CONTENT "APPL????")
+    # Populate Contents/Resources subdirectory.
+    file(CONFIGURE OUTPUT ${macos_app}/Contents/Resources/empty.lproj CONTENT "")
+    configure_file(${PROJECT_SOURCE_DIR}/src/qt/res/icons/bitcoin.icns ${macos_app}/Contents/Resources/bitcoin.icns COPYONLY)
+    file(CONFIGURE OUTPUT ${macos_app}/Contents/Resources/Base.lproj/InfoPlist.strings
+      CONTENT "{ CFBundleDisplayName = \"@PACKAGE_NAME@\"; CFBundleName = \"@PACKAGE_NAME@\"; }"
+    )
+
+    add_custom_command(
+      OUTPUT ${PROJECT_BINARY_DIR}/${macos_app}/Contents/MacOS/Bitcoin-Qt
+      COMMAND ${CMAKE_COMMAND} --install ${PROJECT_BINARY_DIR} --config $<CONFIG> --component GUI --prefix ${macos_app}/Contents/MacOS --strip
+      COMMAND ${CMAKE_COMMAND} -E rename ${macos_app}/Contents/MacOS/bin/$<TARGET_FILE_NAME:bitcoin-qt> ${macos_app}/Contents/MacOS/Bitcoin-Qt
+      COMMAND ${CMAKE_COMMAND} -E rm -rf ${macos_app}/Contents/MacOS/bin
+      VERBATIM
+    )
+
+    string(REPLACE " " "-" osx_volname ${PACKAGE_NAME})
+    if(CMAKE_HOST_APPLE)
+      add_custom_command(
+        OUTPUT ${PROJECT_BINARY_DIR}/${osx_volname}.zip
+        COMMAND ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/macdeploy/macdeployqtplus ${macos_app} ${osx_volname} -translations-dir=${QT_TRANSLATIONS_DIR} -zip
+        DEPENDS ${PROJECT_BINARY_DIR}/${macos_app}/Contents/MacOS/Bitcoin-Qt
+        VERBATIM
+      )
+      add_custom_target(deploydir
+        DEPENDS ${PROJECT_BINARY_DIR}/${osx_volname}.zip
+      )
+      add_custom_target(deploy
+        DEPENDS ${PROJECT_BINARY_DIR}/${osx_volname}.zip
+      )
+    else()
+      add_custom_command(
+        OUTPUT ${PROJECT_BINARY_DIR}/dist/${macos_app}/Contents/MacOS/Bitcoin-Qt
+        COMMAND OBJDUMP=${CMAKE_OBJDUMP} ${PYTHON_COMMAND} ${PROJECT_SOURCE_DIR}/contrib/macdeploy/macdeployqtplus ${macos_app} ${osx_volname} -translations-dir=${QT_TRANSLATIONS_DIR}
+        DEPENDS ${PROJECT_BINARY_DIR}/${macos_app}/Contents/MacOS/Bitcoin-Qt
+        VERBATIM
+      )
+      add_custom_target(deploydir
+        DEPENDS ${PROJECT_BINARY_DIR}/dist/${macos_app}/Contents/MacOS/Bitcoin-Qt
+      )
+
+      find_program(ZIP_COMMAND zip REQUIRED)
+      add_custom_command(
+        OUTPUT ${PROJECT_BINARY_DIR}/dist/${osx_volname}.zip
+        WORKING_DIRECTORY dist
+        COMMAND ${PROJECT_SOURCE_DIR}/cmake/script/macos_zip.sh ${ZIP_COMMAND} ${osx_volname}.zip
+        VERBATIM
+      )
+      add_custom_target(deploy
+        DEPENDS ${PROJECT_BINARY_DIR}/dist/${osx_volname}.zip
+      )
+    endif()
+    add_dependencies(deploydir bitcoin-qt)
+    add_dependencies(deploy deploydir)
+  endif()
+endfunction()
diff --git a/cmake/script/macos_zip.sh b/cmake/script/macos_zip.sh
new file mode 100755
index 0000000000..cc51699dc9
--- /dev/null
+++ b/cmake/script/macos_zip.sh
@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) 2024-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or https://opensource.org/license/mit/.
+
+export LC_ALL=C
+
+if [ -n "$SOURCE_DATE_EPOCH" ]; then
+  find . -exec touch -d "@$SOURCE_DATE_EPOCH" {} +
+fi
+
+find . | sort | "$1" -X@ "$2"